diff --git a/.github/workflows/build-book.yml b/.github/workflows/build-book.yml
index 740515edf..8a8df52db 100644
--- a/.github/workflows/build-book.yml
+++ b/.github/workflows/build-book.yml
@@ -42,7 +42,7 @@ jobs:
run: python3 -m pip install nox
- name: Build book
- run: nox -s docs
+ run: nox -s docs-test
# Save html as artifact
- name: Save book html as artifact for viewing
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b3817ab98..bf26b027b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,3 +1,6 @@
+---
+orphan: true
+---
# Contributing Guide for the Python open source software packaging book
This is a community resource. We welcome contributions in the form of issues and/or pull requests to this guide.
diff --git a/conf.py b/conf.py
index 5f6a0e76d..f4498c496 100644
--- a/conf.py
+++ b/conf.py
@@ -61,6 +61,7 @@
"attrs_block",
]
myst_heading_anchors = 3
+myst_footnote_transition = False
# Sphinx_favicon is used now in favor of built in support
# https://pypi.org/project/sphinx-favicon/
diff --git a/noxfile.py b/noxfile.py
index 62324af68..6af652e91 100644
--- a/noxfile.py
+++ b/noxfile.py
@@ -16,6 +16,17 @@ def docs(session):
cmd.extend(build_command + session.posargs)
session.run(*cmd)
+@nox.session(name="docs-test")
+def docs_test(session):
+ """
+ Same as `docs`, but rebuild everything and fail on warnings for testing
+ """
+ session.install("-r", "requirements.txt")
+ cmd = ["sphinx-build"]
+ cmd.extend(['-W', '--keep-going', '-E', '-a'])
+ cmd.extend(build_command + session.posargs)
+ session.run(*cmd)
+
@nox.session(name="docs-live")
def docs_live(session):
diff --git a/tutorials/add-license-coc.md b/tutorials/add-license-coc.md
index af1fc9521..2e8f6ebcd 100644
--- a/tutorials/add-license-coc.md
+++ b/tutorials/add-license-coc.md
@@ -174,7 +174,6 @@ That's it - you've now added a code of conduct to your package directory.
- [ Guide: `CODE_OF_CONDUCT.md` files](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)
- [pyOpenSci package guide `CODE_OF_CONDUCT.md` overview](https://www.pyopensci.org/python-package-guide/documentation/repository-files/code-of-conduct-file.html)
-
:::
## Wrap up
diff --git a/tutorials/publish-conda-forge.md b/tutorials/publish-conda-forge.md
index 5eedb4efc..289c0e34d 100644
--- a/tutorials/publish-conda-forge.md
+++ b/tutorials/publish-conda-forge.md
@@ -44,7 +44,7 @@ Anyone can submit a package to these channels however they must pass a technical
[Learn more about conda channels here.](#about-conda)
-:::{figure-md} pypi-conda-channels
+:::{figure-md} pypi-conda-channels-2
@@ -228,7 +228,7 @@ where it saved the recipe file.
Open the meta.yaml file. The finished `meta.yaml` file that grayskull creates should look like the example below:
-```yaml
+```yaml+jinja
{% set name = "pyospackage" %}
{% set version = "0.1.8" %}
@@ -421,7 +421,7 @@ This is also why we don't suggest you publish to conda-forge as a practice run.
Once you create your pull request, a suite of CI actions will run that build and test the build of your package. A conda-forge maintainer will work with you to get your recipe in good shape and merged.
-:::{figure-md} pypi-conda-channels
+:::{figure-md} conda-forge-pr-build