Update cc template

.cruft.json

@@ -1,6 +1,6 @@
 {
-  "template": "/Users/cmutel/Code/Brightway/cookiecutter-brightwaylib",
-  "commit": "c7aaac82b7465d91c1417b9ddaf634ebaab43ec5",
+  "template": "https://github.com/brightway-lca/cookiecutter-brightwaylib",
+  "commit": "9ee47efb8072303cf6476d873f392c7753d98082",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -17,7 +17,7 @@
       "_copy_without_render": [
         ".github/*"
       ],
-      "_template": "/Users/cmutel/Code/Brightway/cookiecutter-brightwaylib"
+      "_template": "https://github.com/brightway-lca/cookiecutter-brightwaylib"
     }
   },
   "directory": null

.github/workflows/python-package-deploy.yml

@@ -6,6 +6,7 @@ name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
 on:
   push:
     branches: [main, develop]
+    tags: '*'
 jobs:
   build-n-publish:
     name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI

.gitignore

@@ -69,7 +69,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+_build/
 
 # PyBuilder
 target/

.readthedocs.yml

@@ -6,7 +6,7 @@
 version: 2
 
 conda:
-   environment: environment.yaml
+   environment: docs/environment.yaml
 
 sphinx:
    configuration: docs/conf.py

CHANGES.md

@@ -1,4 +1,4 @@
-# bw_interface_schemas Changelog
+# `bw_interface_schemas` Changelog
 
 All notable changes to this project will be documented in this file.
 

CONTRIBUTING.md

@@ -78,8 +78,6 @@ $ pytest
 Unit tests are located in the _tests_ directory,
 and are written using the [pytest][pytest] testing framework.
 
-[pytest]: https://pytest.readthedocs.io/
-
 ## How to submit changes
 
 Open a [pull request] to submit changes to this project.
@@ -109,8 +107,3 @@ This will allow a chance to talk it over with the owners and validate your appro
 
 [pytest]: https://pytest.readthedocs.io/
 [pull request]: https://github.com/brightway-lca/bw_interface_schemas/pulls
-
-
-<!-- github-only -->
-
-[Code of Conduct]: CODE_OF_CONDUCT.md

README.md

@@ -49,3 +49,24 @@ please [file an issue][Issue Tracker] along with a detailed description.
 [License]: https://github.com/brightway-lca/bw_interface_schemas/blob/main/LICENSE
 [Contributor Guide]: https://github.com/brightway-lca/bw_interface_schemas/blob/main/CONTRIBUTING.md
 [Issue Tracker]: https://github.com/brightway-lca/bw_interface_schemas/issues
+
+
+## Building the Documentation
+
+You can build the documentation locally by installing the documentation Conda environment:
+
+```bash
+conda env create -f docs/environment.yml
+```
+
+activating the environment
+
+```bash
+conda activate sphinx_bw_interface_schemas
+```
+
+and [running the build command](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#sphinx-build):
+
+```bash
+sphinx-build docs _build/html --builder=html --jobs=auto --write-all; open _build/html/index.html
+```

docs/conf.py

@@ -1,3 +1,7 @@
+# conf.py
+# Sphinx configuration file
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
 ### import setup ##################################################################################
 
 import datetime
@@ -35,6 +39,12 @@
 # The master toctree document.
 master_doc = 'index'
 
+### intersphinx configuration ######################################################################
+
+intersphinx_mapping = {
+    "bw": ("https://docs.brightway.dev/en/latest/", None),
+}    
+
 ### theme configuration ############################################################################
 
 html_theme = "sphinx_rtd_theme"
@@ -105,4 +115,4 @@
     '*.md',
     '*.json',
     '*.data'
-]
+]

docs/environment.yaml

@@ -1,3 +1,7 @@
+# environment.yaml
+# Conda environment file for Read the Docs build of the Sphinx project
+# https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-file-manually
+
 name: sphinx_bw_interface_schemas
 channels:
   - conda-forge