pyOpenSci Governance

GitHub release (latest by date)

What is pyOpenSci?

pyOpenSci is devoted to building diverse, supportive community around the Python open source tools that drive open science. We do this through:

open peer review
mentorship and
training.

pyOpenSci is an independent organization, fiscally sponsored by Community Initiatives.

We draw inspiration from rOpenSci, a community to help promote, teach, and grow best-practices in software development for the Scientific R stack.

: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 handbook.

Build the governance document locally

Our governance documentation is built with Sphinx which is a documentation tool.

The easiest way to build our documentationis to use the nox automation tool, 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:

Install nox
```
$ pip install nox
```
Build the documentation:
```
$ nox -s docs
```

This should create a local environment in a .nox folder, build the documentation (as specified in the noxfile.py configuration), and the output will be in _build/html.

To build live documentation that updates when you update local files, run the following command:

$ nox -s docs-live

The governance page should automatically open in a new browser window. If it does not, check your terminal for the text "Serving on http://XXX.X.X.X:XXXX". The HTTP address is a link that you can click (or copy and paste into your browser) in order to open the governance page for live editing.