Add hatch scripts to build, serve and watch the docs + docs improvements (#587)

* Add `hatch` scripts to build, serve and watch the docs

* Convert index.rst to index.md

* more fixes

* more convert

* more improvements

* fix rtd

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix readme

* Fix indices and tables

* use ref

* move faq

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: jtpio

.gitignore

@@ -133,6 +133,3 @@ dmypy.json
 
 # macOS
 .DS_Store
-
-# Copied changelog
-docs/source/**/changelog.md

CONTRIBUTING.md

@@ -52,3 +52,27 @@ To run the Python tests, use:
 ```bash
 pytest
 ```
+
+## Documentation
+
+Contributions can also take the form of fixes and improvements to the documentation.
+
+To build the docs, run:
+
+```bash
+hatch run docs:build
+```
+
+To serve the docs:
+
+```bash
+hatch run docs:serve
+```
+
+It is also possible to automatically watch the docs with the following command:
+
+```bash
+hatch run docs:watch
+```
+
+Then open http://localhost:8000 in your browser to view the documentation.

README.md

@@ -30,7 +30,7 @@ See the [adoption guides](https://jupyter-releaser.readthedocs.io/en/latest/how_
 
 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.
 
 The actions can be run on a [fork](https://jupyter-releaser.readthedocs.io/en/latest/how_to_guides/convert_repo_from_releaser.html) of `jupyter_releaser` and target multiple
 repositories, or run as workflows on the [source repositories](https://jupyter-releaser.readthedocs.io/en/latest/how_to_guides/convert_repo_from_repo.html), using

docs/Makefile

@@ -13,14 +13,13 @@
 # sys.path.insert(0, os.path.abspath('.'))
 import importlib.metadata
 import os.path as osp
-import shutil
 
 HERE = osp.abspath(osp.dirname(__file__))
 
 # -- Project information -----------------------------------------------------
 
 project = "Jupyter Releaser"
-copyright = "2021, Project Jupyter"
+copyright = "2024, Project Jupyter"
 author = "Project Jupyter"
 
 # The full version, including alpha/beta/rc tags.
@@ -97,6 +96,4 @@
 
 
 def setup(app):
-    dest = osp.join(HERE, "reference", "changelog.md")
-    shutil.copy(osp.join(HERE, "..", "..", "CHANGELOG.md"), dest)
     app.add_css_file("custom.css")

docs/make.bat

@@ -0,0 +1,12 @@
+# Getting Started
+
+Tutorials. A hands-on introduction to Jupyter Releaser for maintainers.
+
+```{toctree}
+:caption: 'Contents:'
+:maxdepth: 1
+
+making_release_from_repo
+making_release_from_releaser
+generate_changelog
+```