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

Tidy up documentation #729

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
Draft

Conversation

kytta
Copy link

@kytta kytta commented Oct 30, 2023

Short description

This PR regards issue #532. It doesn't introduce much new documentation, but rather re-arranges the existing information into more granular pages.

Proposed changes

  • re-arrange documentation roughly based on the Diataxis framework
    • add API docs for the CreatePDF() function
      • it might be a better idea to document and type-hint public methods in-code and use autodoc
  • add sphinx_reredirects to redirect people from the old pages to the new ones
    • it might be a better idea to use RTD's page redirects, but I don't have access to the admin panel
  • expanded definitions of intersphinx to include Django docs
    • also added a small Sphinx plugin to resolve the :django: refs

Preview: https://xhtml2pdf--729.org.readthedocs.build/en/729/quickstart.html

@kytta kytta force-pushed the 532-better-docs branch 4 times, most recently from 40e8656 to 4f39687 Compare November 7, 2023 20:47
@kytta kytta changed the title Improve documentation Tidy up documentation Nov 8, 2023
@kytta kytta force-pushed the 532-better-docs branch 3 times, most recently from 71dff15 to 3c6b406 Compare November 20, 2023 16:42
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.

None yet

1 participant