Skip to content

Commit 7fcd88a

Browse files
authored
Fix: reorganize index structure for users
2 parents 6a58271 + 3ebfadf commit 7fcd88a

File tree

2 files changed

+69
-11
lines changed

2 files changed

+69
-11
lines changed

_static/pyos.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ h1 {
6969
color: var(--pyos-h1-color);
7070
}
7171
h2 {
72-
margin-top: 80px;
72+
margin-top: 1em;
7373
}
7474

7575
h3 {

index.md

Lines changed: 68 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Community docs
5656
5757
Publish your docs
5858
```
59-
## _new_ Tutorial Series: How to Create a Python Package
59+
## _new_ Tutorial Series
6060

6161
The how to create a Python package tutorial series is being developed
6262
by the community now! Join our community review process or watch development of these tutorials in our [Github repo here](https://github.com/pyOpenSci/python-package-guide).
@@ -100,7 +100,7 @@ by the community now! Join our community review process or watch development of
100100
:::::
101101

102102

103-
## Python packaging ecosystem overview & best practices
103+
## Packaging
104104

105105
Learn about Python packaging best practices. You will also get to know the
106106
the vibrant ecosystem of packaging tools that are available to help you with your Python packaging needs.
@@ -135,31 +135,90 @@ Learn about best practices for:
135135

136136
:::
137137
::::
138+
:::::
138139

140+
## Documentation
141+
142+
:::::{grid} 1 1 2 2
143+
:class-container: text-center
144+
:gutter: 3
139145

140146
::::{grid-item}
141-
:::{card} ✨ Write & Publish Docs ✨
147+
:::{card} ✨ Write The Docs ✨
142148
:class-card: left-aligned
143149

144150
* [Create documentation for your users](/documentation/write-user-documentation/intro)
145151
* [Core files to include in your package repository](/documentation/repository-files/intro)
152+
* [Write tutorials to show how your package is used](/documentation/write-user-documentation/create-package-tutorials)
153+
:::
154+
::::
155+
156+
::::{grid-item}
157+
:::{card} ✨ Developer Docs ✨
158+
:class-card: left-aligned
159+
160+
* [Create documentation for collaborating developers](/documentation/repository-files/contributing-file)
161+
* [Write a development guide](/documentation/repository-files/development-guide)
162+
:::
163+
::::
164+
165+
::::{grid-item}
166+
:::{card} ✨ Document For A Community ✨
167+
:class-card: left-aligned
168+
169+
* [Writing a README file](/documentation/repository-files/readme-file-best-practices)
170+
* [Set norms with a Code of Conduct](/documentation/repository-files/code-of-conduct-file)
171+
* [License your package](/documentation/repository-files/license-files)
172+
:::
173+
::::
174+
175+
::::{grid-item}
176+
:::{card} ✨ Publish Your Docs ✨
177+
:class-card: left-aligned
178+
146179
* [How to publish your docs](/documentation/hosting-tools/intro)
180+
* [Using Sphinx](/documentation/hosting-tools/intro)
181+
* [Markdown, MyST, and ReST](/documentation/hosting-tools/myst-markdown-rst-doc-syntax)
182+
* [Host your docs on Read The Docs or Github Pages](/documentation/hosting-tools/publish-documentation-online)
147183
:::
148184
::::
149185

186+
:::::
187+
188+
## Tests
189+
190+
*We are actively working on this section. [Follow development here.](https://github.com/pyOpenSci/python-package-guide)*
191+
192+
:::::{grid} 1 1 2 2
193+
:class-container: text-center
194+
:gutter: 3
195+
150196
::::{grid-item}
151197
:::{card} ✨ Tests for your Python package ✨
152198
:class-card: left-aligned
153199

154200
* [Intro to testing](tests/index.md)
155201
* [Write tests](tests/write-tests)
156202
* [Types of tests](tests/test-types)
203+
:::
204+
::::
205+
206+
::::{grid-item}
207+
:::{card} ✨ Run your tests ✨
208+
:class-card: left-aligned
209+
157210
* [Run tests locally](tests/run-tests)
158211
* [Run tests in CI](tests/tests-ci)
159-
160-
*We are actively working on this section. [Follow development here.](https://github.com/pyOpenSci/python-package-guide)*
161212
:::
162213
::::
214+
:::::
215+
216+
## Contributing
217+
218+
:::::{grid} 1 1 2 2
219+
:class-container: text-center
220+
:gutter: 3
221+
163222

164223
::::{grid-item}
165224
:::{card} ✨ Code style & Format ✨
@@ -228,20 +287,19 @@ This is a living guide that is updated as tools and best practices evolve in the
228287
Tutorials <tutorials/intro>
229288
```
230289

231-
232290
```{toctree}
233291
:hidden:
234-
:caption: Documentation
292+
:caption: Packaging
235293
236-
Documentation <documentation/index>
294+
Packaging <package-structure-code/intro>
237295
238296
```
239297

240298
```{toctree}
241299
:hidden:
242-
:caption: Packaging
300+
:caption: Documentation
243301
244-
Packaging <package-structure-code/intro>
302+
Documentation <documentation/index>
245303
246304
```
247305

0 commit comments

Comments
 (0)