Skip to content

Commit dfdf270

Browse files
committed
Fix: broken nav
1 parent 34b0701 commit dfdf270

File tree

3 files changed

+60
-47
lines changed

3 files changed

+60
-47
lines changed

documentation/index.md

+13-18
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ Publish Your Docs <hosting-tools/publish-documentation-online>
4343
Website Hosting and Optimization <hosting-tools/website-hosting-optimizing-your-docs>
4444
```
4545

46-
4746
```{important}
4847
Please note that the tools discussed here are those that
4948
we see commonly used in the community. As tools evolve we
@@ -104,30 +103,30 @@ Python workflows. They might be new(er) to Python and/or data science. Or
104103
expert programmers. But they might not have a background in software
105104
development. These users need to know:
106105

107-
* How to install your package
108-
* How to install dependencies that your package requires
109-
* How to get started using the code base
110-
* Information on how to cite your code / give you credit if they are using it
111-
in a research application.
112-
* Information on the license that your code uses so they know how they can
113-
or can't use the code in an operational setting.
106+
- How to install your package
107+
- How to install dependencies that your package requires
108+
- How to get started using the code base
109+
- Information on how to cite your code / give you credit if they are using it
110+
in a research application.
111+
- Information on the license that your code uses so they know how they can
112+
or can't use the code in an operational setting.
114113

115114
### 2. Potential tool contributors
116115

117116
The other subset of users are more experienced and/or more engaged
118117
with your package. As such they are
119118
potential contributors. These users:
120119

121-
* might have a software development background,
122-
* might also be able to contribute bug fixes to your package or updates to your documentation
123-
* might also just be users who will find spelling errors in your documentation, or bugs in your tutorials.
120+
- might have a software development background,
121+
- might also be able to contribute bug fixes to your package or updates to your documentation
122+
- might also just be users who will find spelling errors in your documentation, or bugs in your tutorials.
124123

125124
These users need all of the things that a basic user needs. But, they
126125
also need to understand how you'd like for them to contribute to your
127126
package. These potential contributors need:
128127

129-
* A development guide to help them understand the infrastructure used in your package repository.
130-
* Contributing guidelines that clarify the types of contributions that you welcome and how you'd prefer those contributions to be submitted.
128+
- A development guide to help them understand the infrastructure used in your package repository.
129+
- Contributing guidelines that clarify the types of contributions that you welcome and how you'd prefer those contributions to be submitted.
131130

132131
```{important}
133132
It's important to remember that the definition of what a contribution is can be
@@ -136,7 +135,6 @@ spelling issue in your documentation. Or it could be a code fix that includes a
136135
new test that covers an edge-case that they discovered.
137136
```
138137

139-
140138
## Documentation elements that pyOpenSci looks for reviewing a Python package
141139

142140
In the pyOpenSci open peer review, we look for
@@ -149,12 +147,12 @@ that you should consider in your package's documentation in more detail.
149147

150148
<!-- TODO: EIC checks are missing: code of conduct -->
151149

152-
153150
```{button-link} https://www.pyopensci.org/software-peer-review/how-to/editor-in-chief-guide.html#editor-checklist-template
154151
:color: primary
155152
:class: sd-rounded-pill float-left
156153
View pyOpenSci peer review check list
157154
```
155+
158156
<!--
159157
1. Individual files in your GitHub (or GitLab) repository including:
160158
* [A clear and to the point **README.md** file](readme-file-best-practices) that includes information about how to cite your package.
@@ -176,16 +174,13 @@ alt: Image showing the files in the the MovingPandas GitHub repository. Files in
176174
An example from the MovingPandas GitHub repository with all of the major files in it including CONTRIBUTING.md, README.md, CODE_OF_CONDUCT.md and a LICENSE.txt file. *(screen shot taken Nov 23 2022)*
177175
```
178176

179-
180-
181177
## What's next in this Python package documentation section?
182178

183179
In this section of the pyOpenSci package guide, we will walk
184180
you through best practices for setting up
185181
documentation for your Python package. We will also suggest
186182
tools that you can use to build your user-facing documentation website.
187183

188-
189184
<!--
190185
Commenting this out for now - it will be moved to another section
191186

index.md

-28
Original file line numberDiff line numberDiff line change
@@ -153,34 +153,6 @@ Good meets the requirements. Going beyond the minimum can make package maintenan
153153
This guide is now a work in progress. If you have ideas of things you'd like
154154
to see here, [we invite you to open an issue on GitHub that details any changes or additions that you'd like to see.](https://github.com/pyOpenSci/python-package-guide/issues).
155155

156-
```{toctree}
157-
:hidden:
158-
:caption: Documentation
159-
160-
Documentation Overview <documentation/index>
161-
Write User Documentation <documentation/write-user-documentation/intro>
162-
Core GitHub Repository Files <documentation/repository-files/intro>
163-
Documentation Tools & Hosting <documentation/hosting-tools/intro>
164-
```
165-
166-
```{toctree}
167-
:hidden:
168-
:caption: Package structure & code style
169-
170-
Manage Package Versions <package-structure-code/python-package-versions>
171-
Publish Package PyPI Conda <package-structure-code/publish-python-package-pypi-conda>
172-
Code Style & Format <package-structure-code/code-style-linting-format>
173-
Intro <python-packaging/intro>
174-
175-
```
176-
177-
```{toctree}
178-
:hidden:
179-
:caption: CI and Testing
180-
181-
Intro <ci-and-testing/intro>
182-
```
183-
184156
<!--
185157
COMMENTED OUT TEXT TO BE MOVED
186158

package-structure-code/intro.md

+47-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,52 @@ there are some great modern packaging tools that ensure that you're following
99
best practices. Here, we review tool features and suggest tools that might be
1010
best fitted for your workflow.
1111

12+
::::{grid} 1 1 2 2
13+
:class-container: text-center
14+
:gutter: 3
15+
16+
:::{grid-item-card}
17+
:link: python-package-build-tools
18+
:link-type: doc
19+
20+
✨ Finding the right packaging tool(s) ✨
21+
^^^
22+
23+
Learn more about the suite of packaging tools out there.
24+
And learn which tool might be best for you.
25+
:::
26+
27+
:::{grid-item-card}
28+
:link: python-package-structure
29+
:link-type: doc
30+
31+
✨ Package file structure ✨
32+
^^^
33+
src layout, flat layout and where should tests folders live? No matter what your level of packaging knowledge is, this page will help you decide upon a package structure that follows modern python best practices.
34+
:::
35+
36+
:::{grid-item-card}
37+
:link: python-package-build-tools
38+
:link-type: doc
39+
40+
✨ Publish to PyPI and Conda ✨
41+
^^^
42+
If you have a pure python package, it's a straight forward
43+
process to publish to both PyPI and then a Conda channel such as
44+
conda-forge. Learn more here.
45+
:::
46+
47+
:::{grid-item-card}
48+
:link: code-style-linting-format
49+
:link-type: doc
50+
51+
✨ Code style & linters ✨
52+
^^^
53+
Black, blue, flake8, Ruff - which tools can help you ensure your
54+
package follows best practices for code format? Learn more about the options and why this is important here.
55+
:::
56+
::::
57+
1258
:::{figure-md} fig-target
1359

1460
<img src="../images/python-package-tools-decision-tree.png" alt="Figure showing a decision tree with the various packaging tool front-end and back-end options." width="700px">
@@ -98,8 +144,8 @@ Complex Builds <complex-python-package-builds>
98144
:hidden:
99145
:caption: Publishing a package
100146
147+
Publish with Conda / PyPI <publish-python-package-pypi-conda>
101148
Package versions <python-package-versions>
102149
Code style <code-style-linting-format>
103-
Publish <publish-python-package-pypi-conda.md>
104150
105151
```

0 commit comments

Comments
 (0)