You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-11
Original file line number
Diff line number
Diff line change
@@ -21,23 +21,21 @@ the Python open source tools that drive open science. We do this through:
21
21
pyOpenSci is an independent organization, fiscally sponsored by Community
22
22
Initiatives.
23
23
24
-
:construction: Construction note :construction:
25
-
26
-
This repository is currently under heavy construction. So please note that if
27
-
you are working through the content!
28
-
29
24
## Contributing statement
30
25
31
26
32
27
## How to setup
33
28
34
-
This repository contains the source files for the [pyOpenSci governance](https://pyopensci.org/governance).
29
+
This repository contains the source files for the [pyOpenSci Python packaging guide](https://pyopensci.org/python-package-guide).
30
+
31
+
## Build the guidebook locally
35
32
36
-
## Build the governance document locally
33
+
Our guidebook is built with [Sphinx](https://sphinx-doc.org) which is a documentation tool and uses the pydata-sphinx-theme.
37
34
38
-
Our governance documentation is built with [Sphinx](https://sphinx-doc.org) which is a documentation tool.
35
+
The easiest way to build our documentation is to use [the `nox` automation tool](https://nox.thea.codes/),
36
+
a tool for quickly building environments and running
37
+
commands within them.
39
38
40
-
The easiest way to build our documentationis to use [the `nox` automation tool](https://nox.thea.codes/), a tool for quickly building environments and running commands within them.
41
39
Using `nox` ensures that your environment has all the dependencies needed to build the documentation.
42
40
43
41
To build, follow these steps:
@@ -64,8 +62,8 @@ $ nox -s docs-live
64
62
65
63
## Contributing to this guide
66
64
67
-
We welcome and issues and pull-requests to improve the content of this guide.
68
-
If you'd like to see an improvement, please [open an issue](https://github.com/pyOpenSci/governance/issues/new/choose).
65
+
We welcome and issues and pullrequests to improve the content of this guide.
66
+
If you'd like to see an improvement, please [open an issue](https://github.com/pyOpenSci/python-package-guide/issues/new/choose).
0 commit comments