Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unified documentation #172

Open
nsoblath opened this issue Sep 4, 2024 · 4 comments
Open

Unified documentation #172

nsoblath opened this issue Sep 4, 2024 · 4 comments
Assignees

Comments

@nsoblath
Copy link
Member

nsoblath commented Sep 4, 2024

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 allgoodpnw self-assigned this Sep 25, 2024
@allgoodpnw
Copy link
Collaborator

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

@allgoodpnw
Copy link
Collaborator

readdocs.yml in root
doc/conf.py

@allgoodpnw
Copy link
Collaborator

need documentation of the actual api

@allgoodpnw
Copy link
Collaborator

branch off of develop

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants