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.

Sign up for GitHub

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

Jump to bottom

docs: order guides and put back python-plugin separation #2310

Merged
merged 2 commits into from
Oct 14, 2024
Merged

docs: order guides and put back python-plugin separation #2310

merged 2 commits into from
Oct 14, 2024

Conversation

antazoey
Copy link
Member

@antazoey antazoey commented Oct 4, 2024

What I did

Uses new features from https://github.com/ApeWorX/sphinx-ape/pulls to improve the docs.

  • Adds a book-like order to the userguides.
  • Adds a plugin prefix so plugin python docs can be separated

How I did it

auto TOC directive inputs

How to verify it

Use that sphinx-ape branch and build the docs:

Screenshot 2024-10-04 at 11 43 41 Screenshot 2024-10-04 at 11 43 55

Checklist

  • All changes are completed
  • New test cases have been added
  • Documentation has been updated

@antazoey antazoey mentioned this pull request Oct 4, 2024
Merged
3 tasks
@antazoey antazoey marked this pull request as ready for review October 14, 2024 18:22
@antazoey antazoey merged commit c230a91 into ApeWorX:main Oct 14, 2024
16 checks passed
@antazoey antazoey deleted the docs/order-toc branch October 14, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bitwise-constructs bitwise-constructs bitwise-constructs approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@antazoey @bitwise-constructs