Skip to content

Commit 8a3c5c8

Browse files
authored
Fix: readme file updates (#168)
1 parent 12a6494 commit 8a3c5c8

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,21 @@ the Python open source tools that drive open science. We do this through:
2121
pyOpenSci is an independent organization, fiscally sponsored by Community
2222
Initiatives.
2323

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-
2924
## Contributing statement
3025

3126

3227
## How to setup
3328

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
3532

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.
3734

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.
3938

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.
4139
Using `nox` ensures that your environment has all the dependencies needed to build the documentation.
4240

4341
To build, follow these steps:
@@ -64,8 +62,8 @@ $ nox -s docs-live
6462

6563
## Contributing to this guide
6664

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 pull requests 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).
6967

7068
## Contributors ✨
7169

0 commit comments

Comments
 (0)