Fix missing API documentation on ReadTheDocs #62
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
- Remove :noindex: directive from pystackql.rst to allow Sphinx to generate API docs - Add :special-members: directive to include __init__ documentation - Configure autodoc with proper default options in conf.py - Add sphinx.ext.napoleon extension for better docstring parsing - Create .readthedocs.yaml configuration file for proper RTD builds - Install package during build to enable autodoc to import and document the module This fixes the issue where StackQL class properties and methods were not being documented on ReadTheDocs.
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.
This fixes the issue where StackQL class properties and methods were not being documented on ReadTheDocs.