Getting Started

Contributions to this documentation are welcome. Documentation is written in reStructured Text (rST). A quick rST reference can be found here. Builds are powered by Sphinx and are hosted by ReadTheDocs.

Fork, clone, install

First, fork the COSDev repo, clone it, and install the requirements (requires Python 2.7 or 3.4 with pip):

# After forking CenterForOpenScience/COSDev
$ git clone<your_github_username>/COSDev.git
$ cd COSDev
$ pip install -r requirements.txt

Be sure to replace <your_github_username> with your Github username.

Build the docs

To build docs:

$ invoke docs -b

The -b (for “browse”) automatically opens up the docs in your browser after building. Alternatively, you can open up the docs/_build/index.html file manually.

Autobuilding on File Changes

You can use sphinx-autobuild to automatically build the docs when you change a file in the docs directory.

To install sphinx-autobuild:

$ pip install sphinx-autobuild

You can now start the livereload server with:

$ invoke watch

Point your browser to http://localhost:8000 to see your docs.

Send a PR!

Once you are done making your edits, send a pull request on Github to the COSDev repo.

Header Conventions

Use the following underlining conventions for heading levels:

  • = for h1
  • * for h2
  • - for h3
  • ^ for h4