|
|
Here is a readme file to help the setup of sphinx documentation (for python scripts)
|
|
|
|
|
|
Before make html, execute :
|
|
|
|
|
|
source ~/.yafits.bashrc
|
|
|
|
|
|
sphinx-apidoc -o ./source/ ../foo/ --force
|
|
|
make clean
|
|
|
make html
|
|
|
|
|
|
|
|
|
# rm docs
|
|
|
# sphinx-quickstart
|
|
|
|
|
|
Editer le conf.py, ici un exemple
|
|
|
|
|
|
# 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('../../foo/'))
|
|
|
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
|
|
project = 'P'
|
|
|
copyright = '2021, P'
|
|
|
author = 'P'
|
|
|
|
|
|
|
|
|
# -- 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.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc']
|
|
|
|
|
|
# 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_rtd_theme'
|
|
|
|
|
|
# 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']
|
|
|
|
|
|
|
|
|
Editer index.rst, ici un exemple
|
|
|
|
|
|
.. P documentation master file, created by
|
|
|
sphinx-quickstart on Thu Nov 4 17:44:19 2021.
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
|
Welcome to P's documentation!
|
|
|
=============================
|
|
|
|
|
|
.. toctree::
|
|
|
:maxdepth: 2
|
|
|
:caption: Contents:
|
|
|
|
|
|
modules
|
|
|
|
|
|
Indices and tables
|
|
|
==================
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
* :ref:`modindex`
|
|
|
* :ref:`search`
|
|
|
|
|
|
|
|
|
|
|
|
[readme](uploads/7a00255e7c1bcd0322890969637b5756/readme) |
|
|
\ No newline at end of file |