Mirroristas/planetmint
2
0
Fork 0
mirror of https://github.com/planetmint/planetmint.git synced 2025-07-09 05:52:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

upgraded sphinx

Browse Source 
Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com>
This commit is contained in:
Jürgen Eckel 2022-05-10 00:08:39 +02:00
parent 395f078e9e
commit 5d22dfa114
2 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/root/requirements.txt
View File

@ -1,5 +1,5 @@
Sphinx~=1.0 Sphinx>=2.1.0
recommonmark>=0.4.0 #recommonmark>=0.4.0
sphinx-rtd-theme>=0.1.9 sphinx-rtd-theme>=0.1.9
sphinxcontrib-napoleon>=0.4.4 sphinxcontrib-napoleon>=0.4.4
sphinxcontrib-httpdomain>=1.5.0 sphinxcontrib-httpdomain>=1.5.0
@ -8,3 +8,4 @@ aafigure>=0.6
packaging~=18.0 packaging~=18.0
wget wget
jinja2==3.0.0 jinja2==3.0.0
myst-parser

19
docs/root/source/conf.py
View File

@ -23,9 +23,7 @@ import sys
import inspect import inspect
from os import rename, remove from os import rename, remove
from recommonmark.parser import CommonMarkParser #from recommonmark.parser import CommonMarkParser
# If extensions (or modules to document with autodoc) are in another directory, # 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 # add these directories to sys.path here. If the directory is relative to the
@ -51,9 +49,12 @@ sys.path.insert(0,parentdir)
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
project = 'Planetmint'
import sphinx_rtd_theme import sphinx_rtd_theme
extensions = [ extensions = [
'myst_parser',
'sphinx.ext.autosectionlabel', 'sphinx.ext.autosectionlabel',
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinx.ext.intersphinx', 'sphinx.ext.intersphinx',
@ -61,6 +62,7 @@ extensions = [
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx.ext.todo', 'sphinx.ext.todo',
'sphinx.ext.napoleon', 'sphinx.ext.napoleon',
#'sphinx.project',
'sphinxcontrib.httpdomain', 'sphinxcontrib.httpdomain',
'aafigure.sphinxext', 'aafigure.sphinxext',
# Below are actually build steps made to look like sphinx extensions. # Below are actually build steps made to look like sphinx extensions.
@ -99,9 +101,9 @@ autodoc_default_options = {
'members': None, 'members': None,
} }
source_parsers = { #source_parsers = {
'.md': CommonMarkParser, # '.md': CommonMarkParser,
} #}
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
@ -115,9 +117,8 @@ source_suffix = ['.rst', '.md']
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
autosectionlabel_prefix_document = True
# General information about the project. # General information about the project.
project = 'Planetmint'
now = datetime.datetime.now() now = datetime.datetime.now()
copyright = str(now.year) + ', Planetmint Contributors' copyright = str(now.year) + ', Planetmint Contributors'
author = 'Planetmint Contributors' author = 'Planetmint Contributors'
@ -137,7 +138,7 @@ release = _version['__version__']
# #
# This is also used if you do content translation via gettext catalogs. # This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases. # Usually you set "language" from the command line for these cases.
language = None language = 'en'
# There are two options for replacing |today|: either, you set today to some # There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used: # non-false value, then it is used: