Skip to content

Fix: readme file updates #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 20, 2024
Merged

Fix: readme file updates #168

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,21 @@ the Python open source tools that drive open science. We do this through:
pyOpenSci is an independent organization, fiscally sponsored by Community
Initiatives.

:construction: Construction note :construction:

This repository is currently under heavy construction. So please note that if
you are working through the content!

## Contributing statement


## How to setup

This repository contains the source files for the [pyOpenSci governance](https://pyopensci.org/governance).
This repository contains the source files for the [pyOpenSci Python packaging guide](https://pyopensci.org/python-package-guide).

## Build the guidebook locally

## Build the governance document locally
Our guidebook is built with [Sphinx](https://sphinx-doc.org) which is a documentation tool and uses the pydata-sphinx-theme.

Our governance documentation is built with [Sphinx](https://sphinx-doc.org) which is a documentation tool.
The easiest way to build our documentation is to use [the `nox` automation tool](https://nox.thea.codes/),
a tool for quickly building environments and running
commands within them.

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

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

## Contributing to this guide

We welcome and issues and pull-requests to improve the content of this guide.
If you'd like to see an improvement, please [open an issue](https://github.com/pyOpenSci/governance/issues/new/choose).
We welcome and issues and pull requests to improve the content of this guide.
If you'd like to see an improvement, please [open an issue](https://github.com/pyOpenSci/python-package-guide/issues/new/choose).

## Contributors ✨

Expand Down