Skip to content

Add hatch scripts to build, serve and watch the docs + docs improvements #585

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

Closed
wants to merge 8 commits into from

Conversation

jtpio
Copy link
Member

@jtpio jtpio commented Oct 18, 2024

A couple of improvements to the docs setup:

  • Add hatch script to serve the docs
  • Use sphinx-autobuild to watch the docs
  • Remove the previous Makefile
  • Mention building the docs in CONTRIBUTING.md
  • Convert more .rst to .md
  • Remove "Background" from the nav bar, add "Changelog" and "FAQ" for visibility:

image

@jtpio jtpio added the documentation Improvements or additions to documentation label Oct 18, 2024
@jtpio jtpio changed the title Add hatch scripts to build, serve and watch the docs Add hatch scripts to build, serve and watch the docs + docs improvements Oct 18, 2024
@jtpio jtpio closed this Oct 18, 2024
@jtpio jtpio reopened this Oct 18, 2024
@jtpio jtpio marked this pull request as ready for review October 18, 2024 15:42
@jtpio
Copy link
Member Author

jtpio commented Oct 18, 2024

Ah, not sure why the rest of the CI does not trigger 🤔

@jtpio jtpio marked this pull request as draft October 18, 2024 15:53
@jtpio
Copy link
Member Author

jtpio commented Oct 18, 2024

Ah, it looks like GitHub may have automatically disabled them?

image

Let's try again.

@jtpio jtpio closed this Oct 18, 2024
@jtpio jtpio reopened this Oct 18, 2024
@jtpio
Copy link
Member Author

jtpio commented Oct 18, 2024

check-release passes on #586.

So closing and re-opening a new PR to check if that fixes the checks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant