pylib/pydocs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

sphinx api index creation

Browse Source
This commit is contained in:
Dirk Alders 2025-08-15 00:38:34 +02:00
parent e61dbc130c
commit 1f0791f30c
2 changed files with 3 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
sphinx.mk
View File

@ -22,8 +22,8 @@ conf.py: pydocs/templates/conf.py.tpl
pydocs/replace.sh conf.py "<author>" "Dirk Alders" pydocs/replace.sh conf.py "<author>" "Dirk Alders"
index.rst: pydocs/templates/index.rst.tpl index.rst: pydocs/templates/index.rst.tpl
cp pydocs/templates/index.rst.tpl index.rst venv/bin/sphinx-apidoc -TMo . $(SPHINXPRJ)
pydocs/replace.sh index.rst "<module_name>" "$(SPHINXPRJ)" mv $(SPHINXPRJ).rst index.rst
html: examples conf.py index.rst html: examples conf.py index.rst
echo -e "\e[1m * Generated html files...\e[0m" echo -e "\e[1m * Generated html files...\e[0m"
@ -35,7 +35,7 @@ examples:
localclean: localclean:
echo -e "\033[1;33mCleanung up docs...\033[00m" echo -e "\033[1;33mCleanung up docs...\033[00m"
echo -e "\e[1m * Sphix config files...\e[0m" echo -e "\e[1m * Sphix config files...\e[0m"
rm -vf conf.py index.rst rm -vf conf.py *.rst
echo -e "\e[1m * Sphix build directory...\e[0m" echo -e "\e[1m * Sphix build directory...\e[0m"
rm -rf $(BUILDDIR) rm -rf $(BUILDDIR)
make --no-print-directory -kC $(SPHINXPRJ)/_examples_ clean make --no-print-directory -kC $(SPHINXPRJ)/_examples_ clean

24
templates/index.rst.tpl
View File

@ -1,24 +0,0 @@
.. documentation master file, created by
sphinx-quickstart on Fri Jan 1 19:56:01 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to <module_name> documentation!
=======================================
.. automodule:: <module_name>
:members:
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`