-
Notifications
You must be signed in to change notification settings - Fork 2
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
Sphinx Docs #17
Sphinx Docs #17
Conversation
i'm wondering whether i should already set up GitHub Actions for building the docs. |
@@ -15,6 +15,7 @@ opentimelineio = "^0.16.0" | |||
pytest = "^6.2.0" | |||
opencolorio = "^2.3.2" | |||
selenium = "^4.20.0" | |||
sphinx = "^7.3.7" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could not resolve this with on windows with my poetry lock, but this is not a problem since once I had removed it it had been recreated again correctly.
- Added new Sphinx extensions and a custom theme for improved documentation appearance. Updated dependencies for documentation building.
If you know how to, then lets do it! :D |
yeeees. was just waiting for ur go :D |
…ns' into 15-refining-docstrings-for-code-api-enhancement
Update typing in OCIO configuration file and ImageInfo class, add optional types. Refactor SlateHtmlGenerator into a plain Python class and add tests.
…-enhancement-docs-refactor 15 Refining Docstrings for Code API Enhancement
let's disable the type annotations in the built docs |
lemme check out how to suggest formatting/linting issues with GH actions. i'll explore this on a different PR |
Description
This PR improves on docstrings, builds sphinx documentation and serves them on https://ynput.github.io/LabLib .
gh-pages
README.md
to rst usingpandoc
Testing Notes
main
before mergingstart.ps1 set-env
$PYTHONPATH
is for, else the sphinxconf.py
doesn't findlablib
cd .\docs\
poetry run make html
.\docs\_build\html\
closes #15