Switch docs to sphinx #37
Merged
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
Move info from old virtac/README.rst, virtac/FEEDBACK_SYSTEMS.rst into sphinx docs. Changed main README.rst to markdown and changed to work better with sphinx. Deleted some unused docs files. Updated conf.py to allow use of html images
Changes the names of various types so that Sphinx can add the correct link to the relevant docs. Such as changing the type callable to typing.Callable. There are many more to fix, but lots of them are due to missing docs to link to for pytac and pyAT
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #37 +/- ##
=======================================
Coverage 93.84% 93.84%
=======================================
Files 6 6
Lines 390 390
=======================================
Hits 366 366
Misses 24 24 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ptsOSL
force-pushed
the
switch-docs-to-sphinx
branch
from
0d4ed37 to
c107575
Compare
Collaborator
Author
|
Did a force push to remove two commits which cancelled each other out. I probably should have done these commits on a separate testing branch. |
MJGaughran
reviewed
Apr 10, 2025
Also add sphinx nitpick exceptions
Mostly adding missing docstrings to classes or fixing syntax. The actual docstring content has not yet been properly updated and needs a refresh which will be done later.
MJGaughran
approved these changes
Apr 11, 2025
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.
Uh oh!
There was an error while loading. Please reload this page.