Convert docs from rst to md

openscm · Jan 14, 2024 · c8f64b6 · c8f64b6
1 parent ab3e5d1
commit c8f64b6
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 304 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,6 @@
 
 TODO:
 
-- convert docs from rst to md
 - TODO: work out how to handle package data
 - Change notebooks into papermill style
 - Update notebook tests
@@ -14,6 +13,18 @@ TODO:
 - add sidebar back into docs in copier
 - add feature request issue template to copier
 - add feature-request label to both GitHub and GitLab orgs (if they don't exist, otherwise update feature request template to match existing name)
+- add contributor docs about how to contribute in different ways to copier, e.g.
+  - tutorials
+  - docs
+  - bug reports
+  - bug fixes
+  - feature requests
+  - pull requests
+- add contributor info re workflows
+  - only push to your own branches (semi-enforced by GitHub's forking workflow but a good reminder)
+  - tools we use
+  - small MRs
+- other learnings from the basic copier setup into copier
 
 <!---
 Can use start-after and end-before directives in docs, see

diff --git a/docs/source/api/openscm_runner.operations.rst b/docs/source/api/openscm_runner.operations.rst
diff --git a/docs/source/api/openscm_runner.rst b/docs/source/api/openscm_runner.rst
@@ -10,7 +10,6 @@ API Reference
   :toctree: ./
 
   openscm_runner.adapters
-  openscm_runner.operations
   openscm_runner.progress
   openscm_runner.run
   openscm_runner.settings

diff --git a/docs/source/development.rst b/docs/source/development.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
diff --git a/docs/source/run.rst b/docs/source/run.rst
diff --git a/docs/source/settings.rst b/docs/source/settings.rst
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
diff --git a/docs/source/utils.rst b/docs/source/utils.rst