driplineorg / dripline-python

python implementation of project8/dripline
Apache License 2.0
3 stars 6 forks source link

Unified documentation #172

Open nsoblath opened 2 months ago

nsoblath commented 2 months ago

The dripline-python package is divided between (1) C++ code with python bindings and (2) pure python code built on top of the bound code. From a user perspective, this appears all as one dripline package because the bound code, as a package called _dripline, is imported into the dripline package.

We want to have a unified documentation interface too. Everything that's available as part of the dripline package should be documented together as a single package, rather than having separate documentation for (1) and (2) [above].

Ideally the processes for maintaining the documentation would be as minimal as possible. There will be some rst source files in the doc directory, and then there will be all of the docstrings in both (1) and (2). Building of the documentation is done by readthedocs.

Building sphinx documentation out of bound C++ code is a thing -- see this pybind11 documentation. Binding the pure python code should be straight-forward Sphinx documentation. Then the trick is how to get it all to work together as one package documentation.

allgoodpnw commented 1 month ago

TODO: get me access to the read the docs for dripline-python repo

allgoodpnw commented 1 month ago

readdocs.yml in root doc/conf.py

allgoodpnw commented 1 month ago

need documentation of the actual api

allgoodpnw commented 1 month ago

branch off of develop