Fix: update for final page review

pyOpenSci · Jan 16, 2024 · 4078d48 · 4078d48
1 parent 596bed9
commit 4078d48
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 12 deletions.
diff --git a/ci-tests-data/ci.md → ci-data/ci.md b/ci-tests-data/ci.md → ci-data/ci.md
diff --git a/ci-data/index.md b/ci-data/index.md
@@ -0,0 +1,11 @@
+# Continuous Integration and Data for your package
+
+
+:::{toctree}
+:hidden:
+:caption: CI & Data
+
+
+What is CI? <ci.md>
+Data <data.md>
+:::
diff --git a/ci-tests-data/data.md b/ci-tests-data/data.md
diff --git a/conf.py b/conf.py
@@ -97,7 +97,7 @@
  "image_light": "logo-light-mode.png",
  "alt_text": "pyOpenSci Python Package Guide. The pyOpenSci logo is a purple flower with pyOpenSci under it. The o in open sci is the center of the flower",
  },
- "header_links_before_dropdown": 4,
+ "header_links_before_dropdown": 5,
  "use_edit_page_button": True,
  "show_nav_level": 2,
  "navigation_depth": 3,

diff --git a/index.md b/index.md
@@ -214,26 +214,35 @@ Tutorials <tutorials/intro>
 ```
 
 
-```{toctree}
+:::{toctree}
 :hidden:
 :caption: Documentation
 
 Documentation <documentation/index>
 
-```
+:::
 
-```{toctree}
+:::{toctree}
 :hidden:
-:caption: Packaging
+:caption: Build & Publish
 
 Packaging <package-structure-code/intro>
 
-```
+:::
 
-```{toctree}
+:::{toctree}
 :hidden:
 :caption: Testing
 
 Tests <tests/index>
 
-```
+:::
+
+
+:::{toctree}
+:hidden:
+:caption: CI & Data
+
+CI & Data <ci-data/index>
+
+:::
diff --git a/package-structure-code/intro.md b/package-structure-code/intro.md
@@ -162,7 +162,7 @@ if you are looking for pyOpenSci's Python package review requirements!
 
 :::{toctree}
 :hidden:
-:caption: Package structure & code style
+:caption: Create & Build Your Package
 
 Intro <self>
 
@@ -176,7 +176,7 @@ Complex Builds <complex-python-package-builds>
 
 :::{toctree}
 :hidden:
-:caption: Publishing a package
+:caption: Publish your package
 
 Publish with Conda / PyPI <publish-python-package-pypi-conda>
 Package versions <python-package-versions>

diff --git a/ci-tests-data/code-cov.md → tests/code-cov.md b/ci-tests-data/code-cov.md → tests/code-cov.md
@@ -1,4 +1,4 @@
-# Code coverage
+# Code coverage for your Python package test suite
 
 Code coverage is the amount of your package's codebase that is run as a part of running your project's tests. A good rule of thumb is to ensure that every line of your code is run at least once during testing. However, note that good code coverage does not guarantee that your package is well-tested. For example, you may run all of your lines of code, but not account for many edge-cases that users may have. Ultimately, you should think carefully about the way your package will be used, and decide whether your tests adequately cover all of that usage.
 

diff --git a/tests/index.md b/tests/index.md
@@ -79,4 +79,5 @@ Write tests <write-tests>
 Test types <test-types>
 Run tests locally <run-tests>
 Run tests online (using CI) <tests-ci>
+Code coverage <code-cov>
 ```