diff options
Diffstat (limited to 'sphinx_conf.py')
| -rw-r--r-- | sphinx_conf.py | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/sphinx_conf.py b/sphinx_conf.py new file mode 100644 index 0000000..c7247ee --- /dev/null +++ b/sphinx_conf.py | |||
| @@ -0,0 +1,84 @@ | |||
| 1 | # Configuration file for the Sphinx documentation builder. | ||
| 2 | # | ||
| 3 | # This file only contains a selection of the most common options. For a full | ||
| 4 | # list see the documentation: | ||
| 5 | # http://www.sphinx-doc.org/en/master/config | ||
| 6 | |||
| 7 | # -- Path setup -------------------------------------------------------------- | ||
| 8 | |||
| 9 | # If extensions (or modules to document with autodoc) are in another directory, | ||
| 10 | # add these directories to sys.path here. If the directory is relative to the | ||
| 11 | # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
| 12 | # | ||
| 13 | # import os | ||
| 14 | # import sys | ||
| 15 | # sys.path.insert(0, '/home/sgs/development/gitprogs/python/pyotp2289/otp2289') | ||
| 16 | |||
| 17 | |||
| 18 | # -- Project information ----------------------------------------------------- | ||
| 19 | |||
| 20 | project = 'pyotp2289' | ||
| 21 | copyright = '2020, Simeon Simeonov' | ||
| 22 | author = 'Simeon Simeonov' | ||
| 23 | |||
| 24 | # The short X.Y version | ||
| 25 | version = '1.0.0' | ||
| 26 | |||
| 27 | # The full version, including alpha/beta/rc tags | ||
| 28 | release = '1.0.0' | ||
| 29 | |||
| 30 | |||
| 31 | # -- General configuration --------------------------------------------------- | ||
| 32 | |||
| 33 | # Add any Sphinx extension module names here, as strings. They can be | ||
| 34 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
| 35 | # ones. | ||
| 36 | extensions = [ | ||
| 37 | 'sphinx.ext.autodoc', | ||
| 38 | 'sphinx.ext.viewcode', | ||
| 39 | 'sphinx.ext.todo', | ||
| 40 | ] | ||
| 41 | |||
| 42 | # Add any paths that contain templates here, relative to this directory. | ||
| 43 | templates_path = ['_templates'] | ||
| 44 | |||
| 45 | # The suffix(es) of source filenames. | ||
| 46 | # You can specify multiple suffix as a list of string: | ||
| 47 | # | ||
| 48 | source_suffix = ['.rst', '.md'] | ||
| 49 | |||
| 50 | # The language for content autogenerated by Sphinx. Refer to documentation | ||
| 51 | # for a list of supported languages. | ||
| 52 | # | ||
| 53 | # This is also used if you do content translation via gettext catalogs. | ||
| 54 | # Usually you set "language" from the command line for these cases. | ||
| 55 | language = 'en' | ||
| 56 | |||
| 57 | # List of patterns, relative to source directory, that match files and | ||
| 58 | # directories to ignore when looking for source files. | ||
| 59 | # This pattern also affects html_static_path and html_extra_path. | ||
| 60 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | ||
| 61 | |||
| 62 | |||
| 63 | # -- Options for HTML output ------------------------------------------------- | ||
| 64 | |||
| 65 | # The theme to use for HTML and HTML Help pages. See the documentation for | ||
| 66 | # a list of builtin themes. | ||
| 67 | # | ||
| 68 | html_theme = 'nature' | ||
| 69 | |||
| 70 | # Add any paths that contain custom static files (such as style sheets) here, | ||
| 71 | # relative to this directory. They are copied after the builtin static files, | ||
| 72 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
| 73 | html_static_path = ['_static'] | ||
| 74 | |||
| 75 | |||
| 76 | # -- Extension configuration ------------------------------------------------- | ||
| 77 | |||
| 78 | # -- Options for todo extension ---------------------------------------------- | ||
| 79 | |||
| 80 | # If true, `todo` and `todoList` produce output, else they produce nothing. | ||
| 81 | todo_include_todos = True | ||
| 82 | |||
| 83 | # Generated by running: sphinx-apidoc with: | ||
| 84 | # -P -F -o html -H pyotp2289 -A "Simeon Simeonov" -V "1.0.0" otp2289 | ||
