pyOpenSci is a vibrant and diverse open science and open source community of practice. We are file down open science and open source pain points associated with sharing and writing better, more maintainable code and software.
Our community runs several programs:
- Open peer review of scientific Python software
- Development of open online education resources for anyone to use.
- online and in-person training events.
pyOpenSci is an independent organization, fiscally sponsored by Community Initiatives.
This repository contains the source files for the pyOpenSci governance handbook.
Our governance documentation is built with Sphinx, a documentation tool.
The easiest way to build our documentation is to use nox, 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 docsThis 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-liveThe 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) to open the handbook page for live editing.
We welcome issues and pull requests to improve the content of this guide. If you'd like to see an improvement, please open an issue.
Thanks goes to these wonderful people (emoji key):
 Karen Cranston 💻 🎨 👀 |
 Tracy Teal 💻 👀 🎨 |
 Leah Wasser 💻 👀 🎨 |
 Jesse Mostipak 💻 👀 |
This project follows the all-contributors specification. Contributions of any kind are welcome!