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

Reduce Sphinx noise in generated docs #1394

Open
4 tasks
tamuri opened this issue Jun 3, 2024 · 0 comments
Open
4 tasks

Reduce Sphinx noise in generated docs #1394

tamuri opened this issue Jun 3, 2024 · 0 comments
Assignees

Comments

@tamuri
Copy link
Collaborator

tamuri commented Jun 3, 2024

  • Remove the linkcheck command from sphinx-build. Takes a while and most of the URLs are broken or behind paywall. Can be run on demand when someone decides to do something about it.
  • Replace the link to source code in Reference docs with a link to Github. This will mean the Sphinx copy of the source code would be redundant, and could also be removed.
  • Remove "View page source" links (and, so, remove copy of source)
  • Remove "Generated by Sphinx" footer
@tamuri tamuri self-assigned this Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Issues
Development

No branches or pull requests

1 participant