docs: improve sphinx docs and add favicon #82
Merged
Conversation
This file contains 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
Owner
yxlao
commented
Dec 30, 2024
•
yxlao
commented
- Various formatting fixes to ensure docs are rendered correctly
- Various consistency fixes of the docstrings and type annotations
- Add favicon and improve documentation theme
- Doc building now follows "warning as error" on CI
…s_png_path` from `io.py` to `util.py` for better code organization and reusability
…ng_path function call for consistency and modularity
…ck formatting for better readability
…for invalid depth representation in docstrings
…nt matrix format descriptions in render.py
…hon' for better readability in documentation
…dability in documentation
… and h_dst/w_dst for clarity in resize function
…ility and consistency
…ropping by eliminating redundant check_with_v1 parameter and validation logic
…to improve readability
…ing across API documentation
…eadability and consistency
… and improving clarity
… code blocks for better readability and consistency
…ple containing" and clarifying return value descriptions
…m_mask_for_eval` to use numpy array type hints for clarity
…n camtools modules - Simplify the documentation build command in `.github/workflows/docs.yml` by using `-C` flag for `make`. - Improve docstring clarity in `camtools/image.py` and `camtools/render.py` by removing redundant descriptions and explicitly naming tuple elements.
…ocstrings to improve readability and maintainability
… in raycast.py and render.py
… clarify its purpose, arguments, and return value
…r.py and solver.py
…ter code clarity and maintainability
…pe across Python versions docs(camtools/util.py): add examples to query_yes_no function for better usage clarity refactor(camtools/util.py): simplify return type descriptions in is_jpg_path and is_png_path functions
…for clarity and maintainability
… theme colors temporarily
…Camera Conventions" for clarity
…era documentation
…r code references
…pdate comments for future inclusion
…dundant matrix form descriptions for clarity
…l.py to sanity.py for better logical organization docs: add API documentation for sanity and util modules
… up configuration file
…de camtools assets docs(conf.py): configure html_theme_options with light and dark logos for better theme customization
…rity and navigation
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.