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

docs: docs rewrite #773

Closed
wants to merge 44 commits into from
Closed

docs: docs rewrite #773

wants to merge 44 commits into from

Conversation

daler
Copy link
Member

@daler daler commented Jun 13, 2022

First pass of rewriting documentation, currently focusing on just the index page to make it as informative as possible for new users without being overwhelming.

Highlights:

  • includes new .. details:: directive and front-page diagram
  • removed the last vestiges of circleci (docs building was the only thing running on it anymore) and ported to GitHub Actions
  • user documentation is all on the first page, deferring to either .. details:: blocks or FAQs
  • includes channel_priority strict recommendation (from docs: recommend strict priorities #776 )
  • updated requirements (as identified by building autosummary docs) and fixed various formatting issues in docstrings

See additional notes for where this is going as a whole.

Edit: now includes fixes #779, #778, #777 (thanks @siebrenf)

@daler daler changed the title docs rewrite docs: docs rewrite Jun 13, 2022
@daler daler mentioned this pull request Jun 20, 2022
@daler
Copy link
Member Author

daler commented Jun 20, 2022

Closing in favor of #781

@daler daler closed this Jun 20, 2022
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.

3 participants