Sphinx Note

README.md

Sphinx Note

ToDo

# initial setting: generate by sphinx-apidoc with -F option
sphinx-apidoc -e -F -o ${DOCUMENT_SOURCE_DIR} ${PYTHON_SOURCE_CODE}
# build
sphinx-build -a -b html ${DOCUMENT_SOURCE_DIR} ${DOCUMENT_PUBLISH_DIR}

---

Useful References

• https://qiita.com/futakuchi0117/items/4d3997c1ca1323259844
• https://qiita.com/icoxfog417/items/9e2eb932b61aa9b9e427

conf.py

# 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:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- 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 os
import sys
sys.path.insert(
    0, os.path.abspath(
        '../../_target_projects/fastapi_nginx_template/app' # example
    )
)


# -- Project information -----------------------------------------------------

project = 'sphinx-test'
copyright = '2020, dummyuser'
author = 'dummyuser'

# The full version, including alpha/beta/rc tags
release = '0.0.1'


# -- 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',
    'sphinx.ext.viewcode',
    'sphinx.ext.todo',
    'sphinx.ext.napoleon',
    'sphinx_rtd_theme',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
# language = 'ja'
language = 'en'

# 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 = []

# latex
latex_engine = "platex"
latex_docclass = {'manual': 'jsbook'}
latex_show_pagerefs = True


# -- 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 = 'alabaster'
html_theme = 'sphinx_rtd_theme'

# html_theme_options = {
#         'canonical_url': '',
#         'logo_only': False,
#         'display_version': True,
#         'prev_next_buttons_location': 'bottom',
#         'style_external_links': False,
#         'style_nav_header_background': 'white',
#         # Toc options
#         'collapse_navigation': True,
#         'sticky_navigation': True,
#         'navigation_depth': 4,
#         'includehidden': True,
#         'titles_only': False
# }

# 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']


# -- Extension configuration -------------------------------------------------

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

requirements_sphinx.txt

# example
Sphinx==3.2.1
sphinx-rtd-theme==0.5.0