add generated docs and logos

Author: Steven Silvester

docs/environment.yml

@@ -9,3 +9,5 @@ dependencies:
   - myst-parser
   - pip:
       - pydata_sphinx_theme
+      - numpydoc
+      - sphinx-click

docs/source/_static/custom.css

@@ -0,0 +1,4 @@
+/* Added to avoid logo being too squeezed */
+.navbar-brand {
+  height: 4rem !important;
+}

docs/source/_static/images/logo/favicon.svg

@@ -32,7 +32,13 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["myst_parser"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "myst_parser",
+    "sphinx_click",
+]
 
 myst_enable_extensions = ["html_image"]
 
@@ -52,6 +58,9 @@
 #
 html_theme = "pydata_sphinx_theme"
 
+html_logo = "_static/images/logo/logo.svg"
+html_favicon = "_static/images/logo/favicon.svg"
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
@@ -74,3 +83,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/source/_static/images/logo/logo.svg

@@ -74,5 +74,7 @@ already uses Jupyter Releaser.
   ![Full Release Workflow Next Step](../images/publish_release_next_step.png)
 
 - **Note** If the publish portion fails you can attempt to publish the draft GitHub release given by the URL in the "\*\* Failure Message \*\*" using the "Publish Release" workflow.
+- **Note** GitHub Actions caches the secrets used on a given workflow run. So if you run into an auth issue, you'll
+  need to run a new workflow instead of re-running the existing workflow.
 - Review and merge the forward-port PR if applicable
 - Announce the release on appropriate channels

docs/source/conf.py

@@ -27,7 +27,7 @@ Note: the only unusable hook names are `before-prep-git` and `before-extract-rel
 
 This is where `jupyter-releaser` looks for configuration (first one found is used):
 
-```code
+```
     .jupyter-releaser.toml
     pyproject.toml (in the tools.jupyter-releaser section )
     package.json (in the jupyter-releaser property)

docs/source/get_started/making_first_release.md

@@ -1,4 +1,30 @@
 API Docs
 ========
 
-Coming soon!
+Library Functions
+-----------------
+.. automodule:: jupyter_releaser.lib
+    :members:
+
+Python Utility Functions
+------------------------
+.. automodule:: jupyter_releaser.python
+    :members:
+
+
+NPM Utility Functions
+------------------------
+.. automodule:: jupyter_releaser.npm
+    :members:
+
+
+Changelog Utility Functions
+---------------------------
+.. automodule:: jupyter_releaser.changelog
+    :members:
+
+
+Global Utility Functions
+------------------------
+.. automodule:: jupyter_releaser.util
+    :members:

docs/source/how_to_guides/write_config.md

@@ -0,0 +1,6 @@
+Releaser CLI
+============
+
+.. click:: jupyter_releaser.cli:main
+  :prog: jupyter-releaser
+  :nested: full