Commit 27fb5f5a authored by karpov-sv's avatar karpov-sv
Browse files

Update doc

parent e1d5c3f4
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.9"
# You can also specify other tool versions:
# nodejs: "16"
# rust: "1.55"
# golang: "1.17"
jobs:
pre_build:
- cd doc && make apidoc
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/conf.py
# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf
# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: requirements_dev.txt
......@@ -8,9 +8,9 @@ PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
# ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
# $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/)
#endif
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
......@@ -226,6 +226,5 @@ pseudoxml:
apidoc:
# sphinx-apidoc -o api/ ../stdpipe --no-toc --separate --no-headings --force
# sphinx-apidoc -o api/ ../stdpipe --no-toc --separate --force
python -m sphinx.ext.apidoc -o api/ ../stdpipe --no-toc --separate --force
@echo
@echo "APIdoc run is complete."
......@@ -36,6 +36,7 @@ extensions = [
# "recommonmark",
# "sphinx_math_dollar",
# "sphinx.ext.autodoc",
"sphinxcontrib.apidoc",
"sphinx.ext.autosummary",
# 'sphinx.ext.pngmath',
# "numpydoc",
......@@ -330,6 +331,12 @@ texinfo_documents = [
# erd_path = os.path.join(os.path.dirname(__file__), 'images/erd.png')
# eralchemy.render_er(models.Base, erd_path)
# ApiDoc
apidoc_module_dir = '../stdpipe'
apidoc_output_dir = 'api'
apidoc_excluded_paths = ['tests']
apidoc_separate_modules = True
apidoc_toc_file = None
def setup(app):
app.add_css_file("stdpipe-docs.css")
......@@ -28,7 +28,7 @@ User Guide
installation
usage
contributing
API documentation <api/stdpipe>
API documentation <api/modules>
Contributing
------------
......
......@@ -4,3 +4,4 @@ sphinx_math_dollar
recommonmark
numpydoc
myst_parser
sphinxcontrib-apidoc
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment