-
Notifications
You must be signed in to change notification settings - Fork 72
Add hatch
scripts to build, serve and watch the docs + docs improvements
#587
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
Conversation
for more information, see https://pre-commit.ci
GitHub actions scripts are available to draft a changelog, draft a release, publish a release, and check a release. | ||
|
||
See the [action details documentation](https://jupyter-releaser.readthedocs.io/en/latest/background/theory.html#action-details) for more information. | ||
See the [action details documentation](https://jupyter-releaser.readthedocs.io/en/latest/reference/theory.html#action-details) for more information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have to remove makefiles or is it just that there is a different way these are no longer needed? I just wonder how much of a burden keeping them is, it feels pretty standard to be able to use make for sphinx compliation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the motivation here was to to keep it simple and have the hatch
scripts be the recommended way for building the docs. And ReadTheDocs can build the docs without the Makefiles.
Also Makefiles tend to look complicated (although it could be more of a personal opinion).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But if they are used by maintainers / contributors of this repo then we could keep them yes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also Makefiles tend to look complicated (although it could be more of a personal opinion).
True
But if they are used by maintainers / contributors of this repo then we could keep them yes.
I would probably switch to hatch commands, not sure about other contributors.
Thanks @krassowski for the review! |
A couple of improvements to the docs setup:
hatch
script to serve the docssphinx-autobuild
to watch the docsMakefile
CONTRIBUTING.md
.rst
to.md