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

MAINT: Clean and update documentation #1429

Merged
merged 37 commits into from
Sep 9, 2024

Conversation

HaoZeke
Copy link
Member

@HaoZeke HaoZeke commented Sep 8, 2024

Closes #1427 and re-hauls the documentation for the new release. For the new release.

@HaoZeke HaoZeke requested a review from mattip September 8, 2024 20:48
@HaoZeke HaoZeke force-pushed the cleanDocs branch 2 times, most recently from b0f9144 to 047febc Compare September 9, 2024 00:23
@mattip
Copy link
Contributor

mattip commented Sep 9, 2024

This is a very large PR, I will find it hard to review. Is there something in particular you would like me to look at?

@HaoZeke
Copy link
Member Author

HaoZeke commented Sep 9, 2024

This is a very large PR, I will find it hard to review. Is there something in particular you would like me to look at?

Ah sorry, I'll highlight a few places, in general there aren't too many differences, mostly cosmetic / documentation changes, that is:

  • Uses bibtex for references, adds a logo (light/dark) and switched to furo
  • Removed the spurious makefile stuff (which accounts for most of the deletions)
  • Moved long module documentation (step detection) into its own page
  • Uses AutoAPI and viewcode for more through documentation
    • This also means the sphinx build doesn't import asv anymore
    • Uses importlib_metadata to consistently get the version as suggested by setuptools_scm

Here is what the documentation looks like at this commit, e88a2ac:
https://tmpasv.surge.sh/

@mattip
Copy link
Contributor

mattip commented Sep 9, 2024

It all seems quite straightforward, go ahead an merge if you are satisfied.

@HaoZeke HaoZeke merged commit c97f52d into airspeed-velocity:main Sep 9, 2024
12 checks passed
@HaoZeke HaoZeke deleted the cleanDocs branch September 9, 2024 13:10
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.

asv dev section still present in documentation after deprecation
2 participants