Skip to content

Autodoc overlooking certain files #8150

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

Closed
bryan-garcia opened this issue Apr 30, 2021 · 2 comments
Closed

Autodoc overlooking certain files #8150

bryan-garcia opened this issue Apr 30, 2021 · 2 comments
Labels
Support Support question

Comments

@bryan-garcia
Copy link

Details

Expected Result

Documentation to be generated for source files in INGRID via autodoc.

Actual Result

Files ingrid.py and topologies/*.py did not generate documentation when built on readthedocs, whereas all other
source files did. Locally this issue does not occur when building.

Additional information

I've already gone ahead and configured my settings online to build the documentation branch.
I followed this post and resolved older issues I had.

Thank you for any help.

@stsewd
Copy link
Member

stsewd commented May 3, 2021

Hi, I can see the docs extracted from sources here https://ingrid.readthedocs.io/en/latest/ingrid.html or is there any other page missing?

@stsewd stsewd added Support Support question Needed: more information A reply from issue author is required labels May 3, 2021
@bryan-garcia
Copy link
Author

Hi, thank you for reaching out. There are no other pages missing and all my documentation is now live. I'm not sure why there was a delay on those two files, but there is no longer an issue.

@no-response no-response bot removed the Needed: more information A reply from issue author is required label May 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Support Support question
Projects
None yet
Development

No branches or pull requests

2 participants