From 46f05a1022a80b2e18746b3517f037e9f64c320e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=BE=9D=E7=91=AA=E8=B2=93?= Date: Wed, 7 Dec 2022 09:48:56 +0800 Subject: [PATCH] Updated the Sphinx version that is used to create the document template. --- docs/make.bat | 6 +++--- docs/source/conf.py | 39 ++++++--------------------------------- docs/source/index.rst | 4 ++-- 3 files changed, 11 insertions(+), 38 deletions(-) diff --git a/docs/make.bat b/docs/make.bat index 6247f7e..747ffb7 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -10,8 +10,6 @@ if "%SPHINXBUILD%" == "" ( set SOURCEDIR=source set BUILDDIR=build -if "%1" == "" goto help - %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( echo. @@ -21,10 +19,12 @@ if errorlevel 9009 ( echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ + echo.https://www.sphinx-doc.org/ exit /b 1 ) +if "%1" == "" goto help + %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% goto end diff --git a/docs/source/conf.py b/docs/source/conf.py index 15101c8..5a22ded 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,59 +1,32 @@ # Configuration file for the Sphinx documentation builder. # -# This file only contains a selection of the most common options. For a full -# list see the documentation: +# For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html import os -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# import sys sys.path.insert(0, os.path.abspath('../../src/')) - # -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'Flask-Digest-Auth' copyright = '2022, imacat' author = 'imacat' - -# The full version, including alpha/beta/rc tags release = '0.3.0' - # -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc" -] +extensions = ["sphinx.ext.autodoc"] -# Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. exclude_patterns = [] + # -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# html_theme = 'sphinx_rtd_theme' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] - -# For readthedocs.io to work properly. -master_doc = 'index' diff --git a/docs/source/index.rst b/docs/source/index.rst index 11c7e59..ce84e15 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ -.. flask-digest-auth documentation master file, created by - sphinx-quickstart on Tue Dec 6 15:15:08 2022. +.. Flask-Digest-Auth documentation master file, created by + sphinx-quickstart on Wed Dec 7 09:40:48 2022. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive.