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

Revamp documentation #551

Open
13 of 15 tasks
padix-key opened this issue Apr 12, 2024 · 0 comments · May be fixed by #552
Open
13 of 15 tasks

Revamp documentation #551

padix-key opened this issue Apr 12, 2024 · 0 comments · May be fixed by #552

Comments

@padix-key
Copy link
Member

padix-key commented Apr 12, 2024 •
edited

This issue tracks the current endeavour to create a modernized cleaner documentation

  • Use pydata theme
  • Reorder gallery
  • Add cleaner homepage
  • Make Installation section more newstarter friendly
  • Use cleaner buttons for extension packages, e.g. cards
  • Logical order of member methods in API reference
  • Fix button to News site
  • Reasonable navigation structure in sidebars
  • Adapt style (e.g. text colors)
  • Refactor tutorial structure
  • Add documentation version switcher
  • Add a proper 404 page
  • Consider using sphinx-copybutton

Nice-to-have tutorials to be added:

  • UniProt
  • PubChem
@padix-key padix-key linked a pull request Apr 12, 2024 that will close this issue
Draft
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Revamp documentation padix-key/biotite
1 participant
@padix-key