sphinx doc - config and module doc pEp._gen / pEp._pEp

REWORK
heck 2 years ago
parent 348fa8f2f9
commit 16e9bda15f

@ -65,8 +65,6 @@ envtest:
install-test: compile
pip3 install .[test]
# TODO: maybe use setup.py test?
# --forked, because every test needs a separate process, see PYADPT-100
test:
pytest
@ -88,6 +86,7 @@ clean-all: clean
rm -rf $(VENV_DIR)
clean: clean-docs
$(MAKE) -C src/pEp/_gen clean-all
rm -rf $(BUILD_DIR)
rm -rf $(DIST_DIR)
rm -rf $(PYTHON_ARTIFACTS)

@ -0,0 +1,8 @@
Module pEp._gen
---------------
.. automodule:: pEp._gen
:members:
:imported-members:
:undoc-members:
:show-inheritance:

@ -0,0 +1,7 @@
Module pEp._pEp
---------------
.. automodule:: pEp._pEp
:members:
:imported-members:
:undoc-members:
:show-inheritance:

@ -1,12 +1,7 @@
pEp package
===========
Module contents
---------------
Module pEp
----------
.. automodule:: pEp
:members:
:imported-members:
:undoc-members:
:show-inheritance:

@ -92,7 +92,7 @@ html_theme = "nature"
# 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"]
#html_static_path = ["_static"]
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.

@ -13,6 +13,9 @@ Welcome to pEpPythonAdapter's documentation!
install
software_using
api/pEp
api/pEp._pEp
api/pEp._gen
Indices and tables
==================

Loading…
Cancel
Save