Fix: various build issues and add nox docs-test to the build (#114)

* fix: issues with build

* fix: various issues with files to fix build

* Update .gitignore

* Fix: stash rebase issue

* Fix: make nox happy

Author: lwasser

.gitignore

@@ -7,4 +7,4 @@ tmp/
 __pycache__
 
 /.luarc.json
- .ipynb_checkpoints/
+**/.ipynb_checkpoints

CONTRIBUTING.md

@@ -1,37 +1,36 @@
 # Contributing Guide for pyOpenSci
 
-This guide is a high level contributing guide that provide guidelines for
-contributing to resources across our organization. You will find specific contributing guidelines in each of the repositories that
+This guide provides high-level contributing guidelines for resources across our organization. You will find specific contributing guidelines in each repository that
 we maintain.
 
-pyOpenSci develops and maintains numerous community resources including:
+pyOpenSci develops and maintains numerous community resources, including:
 
 - [Python packaging guide](https://github.com/pyOpenSci/python-package-guide)
 - Python [software peer review guide](https://github.com/pyOpenSci/software-peer-review)
 - Our [pyopensci.org website](https://github.com/pyOpenSci/pyopensci.github.io)
-- Our [software review repo](https://github.com/pyOpenSci/software-submission): contains templates templates for software submission and a small ci build
+- Our [software review repo](https://github.com/pyOpenSci/software-submission): contains templates templates for software submission and a small CI (Continuous Integration) build
 
 This document applies to any of our online content that you
 contribute to. Most of our content lives in the [pyOpenSci
 GitHub organization](https://github.com/pyopensci).
 
-## High level guidelines
+## High-level guidelines
 
 1. Anyone contributing to pyOpenSci must follow our [organization-wide code of conduct](https://www.pyopensci.org/governance/CODE_OF_CONDUCT.html).
-2. Please open an issue before submitting a pull request with new or revised content. Issues will allow us to discussed the changes with you before they are submitted. Submitting an issue first will expedite the speed at which your pull request is merged.
+2. Please open an issue before submitting a pull request with new or revised content. Issues will allow us to discuss the changes with you before submitting them. Submitting an issue first will expedite the speed at which your pull request is merged.
 
 - In some instances, if your pull request is a simple fix of a link or typo, we may accept it without an issue being opened.
 
-3. If you submit a pull request please be sure to use a branch in your fork. Do not use the `main` branch from your fork to submit a pull request.
-4. Please try to spell check and editor pull requests before opening them in our repository. This will save us time when reviewing your suggested change(s)!
+3. If you submit a pull request, please be sure to use a branch in your fork. Do not use your fork's `main` branch to submit a pull request.
+4. Please try to spell check and editor pull requests before opening them in our repository. This will save us time when reviewing your suggested change(s).
 
 ## Contributor attributions
 
 We welcome and value contributions of all kinds. Some ways that
-you can contribute to pyOpenSci include:
+you can contribute to pyOpenSci, include:
 
-- Identifying typos / issues in our online documentation
-- Fixing bad urls and references in our issue and peer review templates
+- Identifying typos/issues in our online documentation
+- Fixing bad URLs and references in our issue and peer-review templates
 - Opening issues about content in our peer review and packaging guides
 - Reviewing pull requests that update content on our website
 - Contributing to the peer review process
@@ -108,12 +107,12 @@ To build live documentation that updates when you update local files, run::
     nox -s docs-live
     ```
 
-The `docs-live` command will provide ou with a url that you can enter into your
-browser to see the docs update as you make updates to files.
+The `docs-live` command will provide you with a URL that you can enter into your
+browser to see the docs update as you update files.
 
 ### CircleCI Previews
 
-Each book is setup with a GitHub action redirect that will take you to a online
+Each book is set up with a GitHub action redirect that will take you to an online
 build of the current pull request in CircleCI. To view the build:
 
 - Click on the GitHub action called `ci/circleci: build_book` after it has run at the bottom of your pull request. This will
@@ -128,7 +127,3 @@ browser.
 ### Website build
 
 Our website is a `jekyll`/`markdown` driven site. Thus, you will need to install `ruby`, and the gems needed to build the website following the contributing guide in our pyopensci.github.io repository.
-
-```
-
-```

index.md

@@ -1,9 +1,10 @@
 # pyOpenSci Handbook & Governance
 
 This guide is designed to define the structure and processes
-that support operations of pyOpenSci.
+that support pyOpenSci operations.
+
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/pyopensci/governance?color=purple&display_name=tag&style=plastic)](https://github.com/pyOpenSci/handbook/releases) [![DOI](https://zenodo.org/badge/161679308.svg)](https://zenodo.org/badge/latestdoi/161679308) [![All Contributors](https://img.shields.io/badge/all_contributors-3-blue.svg?style=flat-square)](https://github.com/pyOpenSci/handbook?tab=readme-ov-file#contributors-)
 
-![GitHub release (latest by date)](https://img.shields.io/github/v/release/pyopensci/governance?color=purple&display_name=tag&style=plastic) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7120880.svg)](https://doi.org/10.5281/zenodo.7120880) [![All Contributors](https://img.shields.io/badge/all_contributors-4-blue.svg?style=flat-square)](https://github.com/pyopensci/handbook/?tab=readme-ov-file#contributors-)
 
 :::::{grid} 1 1 3 3
 :class-container: text-center

noxfile.py

@@ -1,8 +1,12 @@
+import os
 import pathlib
 
 import nox
 
-nox.options.reuse_existing_virtualenvs = True
+# Sphinx output and source directories
+BUILD_DIR = "_build"
+OUTPUT_DIR = pathlib.Path(BUILD_DIR, "html")
+SOURCE_DIR = pathlib.Path(".")
 
 # Sphinx output and source directories
 BUILD_DIR = "_build"
@@ -42,9 +46,32 @@ def docs(session):
     )
 
 
+@nox.session(name="docs-test")
+def docs_test(session):
+    """
+    Build the packaging guide with more restricted parameters.
+
+    Note: this is the session used in CI/CD to release the guide.
+    """
+    session.install("-e", ".")
+    session.run(
+        SPHINX_BUILD,
+        *BUILD_PARAMETERS,
+        *TEST_PARAMETERS,
+        SOURCE_DIR,
+        OUTPUT_DIR,
+        *session.posargs,
+    )
+    # When building the guide with additional parameters, also build the translations in RELEASE_LANGUAGES
+    # with those same parameters.
+    session.notify("build-translations", ["release-build", *TEST_PARAMETERS])
+
+
 @nox.session(name="docs-live")
 def docs_live(session):
-    session.install("-e", ".")
+    session.install("-e", ".[dev]")
+    if not os.path.exists(OUTPUT_DIR):
+        os.makedirs(OUTPUT_DIR)
 
     cmd = [
         SPHINX_AUTO_BUILD,
@@ -55,6 +82,7 @@ def docs_live(session):
     ]
     for folder in AUTOBUILD_IGNORE:
         cmd.extend(["--ignore", f"*/{folder}/*"])
+
     session.run(*cmd)
 
 

reference/meeting-notes/2019/2019-08-01-notes.md

@@ -4,7 +4,7 @@
 
 Please add your name to the list below!
 
-* Leah Wasser - Earth Lab!
+* Leah Wasser - EarthLab
 * Filipe Fernandes - NOAA/IOOS
 * Daniel Chen - Virginia Tech + RStudio intern @chendaniely
 * Chris Holdgraf - UC Berkeley - @choldgraf
@@ -38,25 +38,25 @@ Please add your name to the list below!
     * Chris
     * Martin
 * Website
-  * who's involved -- generate this programmatically? pull from the list of anyone in the organization -- someone would have to build this - twitter api / travis -- They do this for jupyter hub ..
-  * Chris might be able to copy over what jupyter hub does -- <https://jupyterhub-team-compass.readthedocs.io/en/latest/team.html#jupyterhub-team> read the docs will build it
-    * Following the all contributors specs!! <https://github.com/jupyterhub/team-compass/blob/master/docs/team/contributors-jupyterhub.yaml> -- Chris can work on that next
-    * <https://github.com/jupyterhub/team-compass/tree/master/docs/team>
-  * Website -- links that take you to a github search that filters by tag! -- easy quick (Leah can add this!)
-    * in the future we can automate this
-* Create design repository in the org -- and place the images and branding items in it!! (leah can do this as well)
+    * who's involved -- generate this programmatically? pull from the list of anyone in the organization -- someone would have to build this - twitter api / travis -- They do this for jupyter hub ..
+    * Chris might be able to copy over what jupyter hub does -- https://jupyterhub-team-compass.readthedocs.io/en/latest/team.html#jupyterhub-team read the docs will build it
+        * Following the all contributors specs!! https://github.com/jupyterhub/team-compass/blob/master/docs/team/contributors-jupyterhub.yaml -- Chris can work on that next
+        * https://github.com/jupyterhub/team-compass/tree/master/docs/team
+    * Website -- links that take you to a github search that filters by tag! -- easy quick (Leah can add this!)
+        * in the future, we can automate this
+* Create a design repository in the org -- and place the images and branding items in it!! (leah can do this as well)
 * Funding
-  * pyOpenSci -- [working draft of 2-3 pager]( https://docs.google.com/document/d/13S_HOGS89Zm1j257gC8Oja_Yol3j6xCp68Sr2Ln5MM0/edit)
-  * IDEA -- fund a fellowship position that works full time?? or focuses on this organization
-    * hire them as a contractor -- could be remote, etc
-  * Martin, Daniel, and Mike are both in DC area -- NIH (National Institute of Health)
-    * workshop on packaging your project -- to get more exposure
-      * partnership with Carpentries would be good
-      * other existing online resources: [Molecular Sciences Software Institute (MolSSI) materials](https://molssi-education.github.io/CMS-Python-DevOps/)
-    * Martin - organizer for a local meetup
-      * Stats Programming DC: <https://www.meetup.com/stats-prog-dc/>
-  * Leah to followup with NumFOCUS about sponsorship
+    * pyopensci -- [working draft of 2-3 pager]( https://docs.google.com/document/d/13S_HOGS89Zm1j257gC8Oja_Yol3j6xCp68Sr2Ln5MM0/edit)
+    * IDEA -- fund a fellowship position that works full time?? or focuses on this organization
+        * hire them as a contractor -- could be remote, etc
+    * Martin, Daniel, and Mike are both in DC area -- NIH (National Institute of Health)
+        * workshop on packaging your project -- to get more exposure
+            * partnership with Carpentries would be good
+            * other existing online resources: [ Molecular Sciences Software Institute (MolSSI) materials](https://molssi-education.github.io/CMS-Python-DevOps/)
+        * Martin - organizer for a local meetup
+            * Stats Programming DC: https://www.meetup.com/stats-prog-dc/
+     * Leah to followup with NumFOCUS about sponsorship
 
-* AGU event potentially?? Open source software session presentation
-  * Leo --- ask about something associated with the plenary or something else!!
+* Agu event potentially?? Open source software session presentation
+    * Leo --- ask about something associated with the plenary or something else!!
 * other topics??