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

Update docs building dependencies and configs #113

Merged
merged 3 commits into from
Aug 10, 2023
Merged

Update docs building dependencies and configs #113

merged 3 commits into from
Aug 10, 2023

Conversation

dsagal
Copy link
Member

@dsagal dsagal commented Aug 7, 2023

@dsagal dsagal requested a review from alexmojaki August 7, 2023 15:37
@alexmojaki
Copy link
Contributor

The docs preview is missing ASTText. Did you build it locally without updating master?

@dsagal
Copy link
Member Author

dsagal commented Aug 8, 2023

The issue is that auto-documentation isn't fully automatic, but only selected classes and members are included. So I have to list ASTText explicitly. Including :members: at top level would show that automatically, but in a differently organized layout, so I added ASTText explicitly to keep layout as before. One top-level member not documented is supports_tokenless. Not sure it's worth documenting as a top-level function. Maybe could be moved to util? Anyway, that seems separate from this task.

Copy link
Contributor

@alexmojaki alexmojaki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know what most of this stuff means 🤷

Also I still don't see ASTText in the preview, did you rebuild?

@dsagal
Copy link
Member Author

dsagal commented Aug 10, 2023

Sorry, I hadn't realize that rebuilding from branches wasn't automatic.

@dsagal dsagal merged commit a051af6 into master Aug 10, 2023
14 checks passed
@dsagal dsagal deleted the sphinx-conf branch August 31, 2023 03:34
@alexmojaki
Copy link
Contributor

@dsagal
Copy link
Member Author

dsagal commented Sep 4, 2023

I updated a setting, it rebuilt, and looks up-to-date now. It should be automatic, from skimming https://docs.readthedocs.io/en/stable/versions.html. Maybe it was the missing setting. If it doesn't auto-update after next release, I'd have to debug further.

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