Sphinx-generated documentation #106
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 20 commits
January 12, 2026 12:37
Resolved an issue where some of the C++ side of PyORBIT was getting documented twice. Ignored some macros that were causing errors while building documentation. Documentated a couple of methods as examples.
Building and re-deploying on each PR may be problematic as the github-pages environment is protected.
If things are really busy, the default 10 minutes is an insufficient amount of time to wait in the queue.
Now docs can be built on pull request without attempting to publish to Pages.
This reverts commit cdc67ff.
…ion.github.io This reverts commit 5f422a4. Deploy to pyorbit-collaboration/pyorbit-collaboration.github.io
… and separate markdown files for each pyorbit module
…ilable When `__all__` is defined, `automodapi` uses it to inform for which elements of the module docs should be generated. If for some reason something defined in `__all__` is not actually importable, then the docs will fail to compile. These adjustments make docs compilable for now. Seeking guidance on whether this is the best way to proceed.
Contributor
Author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Produce official documentation for PyORBIT. Automatically generates the Python API reference with
sphinx-automodapi. To enable automatic documentation for the C++ part of the repo, a combination of Doxygen, Breathe, and Exhale is used.Important
New dependencies included in a separate
doc/environment.yml:Todo
sphinx.ext.autosummaryworks intermittently between the various orbit modules.requirements.txtrequired to build docs.Current state is deployed from this feature branch to the following url:
https://pyorbit-collaboration.github.io