Skip to content
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

[Docs] Add docstring to documentation generation with Sphinx Napoleon #479

Closed
wants to merge 1 commit into from

Conversation

chenyenru
Copy link
Contributor

@chenyenru chenyenru commented Aug 5, 2024

Description: Add documentation generation from docstring.

Question:
Per sphinx-apidoc's documentation, building the documentation requires all required dependencies as if developing the code. Else, complete documentation will not be generated. Is there a way to test the edits in .readthedocs.yaml to see if all required dependencies are installed and that documentations are successfully generated?

@StoneT2000 StoneT2000 self-assigned this Aug 5, 2024
@StoneT2000 StoneT2000 self-requested a review August 5, 2024 19:12
@StoneT2000
Copy link
Member

These changes were copied over in a larger docs overhaul in #516

@StoneT2000 StoneT2000 closed this Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants