mirror of
https://github.com/Tech-Workers-Coalition-Italia/mobilizon-reshare.git
synced 2025-02-14 10:40:57 +01:00
8ff6555c60
* initial commit with generate-doc.sh script and generated documentation, added pdoc3 dependency * fixed import errors due to missing SECRETS_FOR_DYNACONF environment value, updated doc, force/overwrite if documentation exists * moved pdoc3 dependency from dependencies to dev-dependencies * removed generated doc * add api-documentation (pdoc3 target directory) to .gitignore * switch to sphinx which supports better typehints notation * remove module path prefix from methods name * add support for typehints * remove autogenerated files * ignore autogenerated files * fixed typo in .gitignore * added empty _static folder to avoid warning on build * initial commit with generate-doc.sh script and generated documentation, added pdoc3 dependency * fixed import errors due to missing SECRETS_FOR_DYNACONF environment value, updated doc, force/overwrite if documentation exists * moved pdoc3 dependency from dependencies to dev-dependencies * removed generated doc * switch to sphinx which supports better typehints notation * remove autogenerated files * remove gui browser documentation open, use /bin/sh instead of /bin/bash * remove windows/dos documentation generation make, drop windows/dos support Co-authored-by: Giacomo Leidi <goodoldpaul@autistici.org>
55 lines
1.9 KiB
Python
55 lines
1.9 KiB
Python
# 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('.'))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "mobilizon-reshare"
|
|
copyright = "2022, -"
|
|
author = "-"
|
|
|
|
|
|
# -- 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 = ["sphinxcontrib.napoleon", "sphinx_autodoc_typehints"]
|
|
|
|
# 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 -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = "sphinx_material"
|
|
|
|
# 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"]
|
|
|
|
# disable full module path in methods list
|
|
add_module_names = False
|