Browse Source

Fix sphinx make targets

Re structure documentation, more simple for now.
PYADPT-100
heck 2 years ago
parent
commit
fab052a75b
6 changed files with 37 additions and 26 deletions
  1. +4
    -1
      Makefile
  2. +1
    -2
      docs/source/conf.py
  3. +0
    -13
      docs/source/documentation.rst
  4. +0
    -3
      docs/source/index.rst
  5. +32
    -0
      docs/source/install.rst
  6. +0
    -7
      docs/source/testing.rst

+ 4
- 1
Makefile View File

@ -8,6 +8,9 @@ all: dist
compile:
python3 setup.py build_ext $(DEBUG_OPT) $(PREFIX_OPT)
compile-inplace:
python3 setup.py build_ext $(DEBUG_OPT) $(PREFIX_OPT) --inplace
# Packaging
# =========
# create wheel and egg package in dist/
@ -65,7 +68,7 @@ develop: compile
# Documentation
# =============
docs:
docs: compile-inplace
make html -C docs/


+ 1
- 2
docs/source/conf.py View File

@ -11,12 +11,11 @@
# 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('../../src'))
# -- Project information -----------------------------------------------------
#from pkg_resources import get_distribution
project = "pEpPythonAdapter"
copyright = "2020, Volker Birk, heck, juga"


+ 0
- 13
docs/source/documentation.rst View File

@ -1,13 +0,0 @@
Building the documentation
=========================
This documentation uses `Sphinx <https://www.sphinx-doc.org/>`_
It can be built in different formats.
Run ``cd docs; make`` to see the possible formats.
Run ``cd docs; make html`` to build the documentation in HTML format.
You can see the generated HTML documentation in a browser opening the directory
`docs/build/html`.

+ 0
- 3
docs/source/index.rst View File

@ -11,11 +11,8 @@ Welcome to pEpPythonAdapter's documentation!
:caption: Contents:
install
testing
documentation
software_using
api/pEp
Indices and tables
==================


+ 32
- 0
docs/source/install.rst View File

@ -76,6 +76,7 @@ You can do this from a clean clone of the repo, no prior actions required, the w
will be compiled and installed into the venv.
``make venv``
``make test``
@ -94,6 +95,37 @@ changes to the C/C++ part of the module (_pEp). If you change just python code,
If you do changes to the C/C++ part you need to issue ``make develop`` again, to recompile the extension and install
the new binary (.so/.dylib) of the module into the venv.
Documentation
-------------
The documentation of the pEpPythonAdapter uses `Sphinx <https://www.sphinx-doc.org/>`_
Refer to the `Sphinx installation instructions <https://www.sphinx-doc.org/en/master/usage/installation.html>`_ to install it.
To generate the documentation in the HTML format, there is a make target "docs"
But first, you need to create/activate the venv or set the LD_LIBRARY_PATH manually.
``make venv``
``make docs``
You can see the generated HTML documentation in a browser opening the directory
`docs/build/html`.
Housekeeping
------------
There are the following "clean" targets.
To delete all the generated documentation, run:
``make docs-clean``
To delete all the "derived" files including eggs, wheels, shared libs, build files and caches, run:
``make clean``
To delete all of make clean plus the venv (should equal a complete reset), run:
``make clean-all``
Docker
------


+ 0
- 7
docs/source/testing.rst View File

@ -1,7 +0,0 @@
Testing
=======
See :ref:`install` to install the dependencies.
To run the tests that use `pytest`, install the testing dependencies running
``pip install .[test]``.

Loading…
Cancel
Save