Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.77 KB

README.md

File metadata and controls

46 lines (34 loc) · 1.77 KB
Raw

openworm_docs

Documentation for OpenWorm, hosted at http://docs.openworm.org.

Make Documentation

Simply modifying the markdown files in this repository should automatically trigger the site to be built and updated via Read the Docs:dev-openworm-docs. More information on contributing to this documentation is available at docs.openworm.org/community (which is generated from docs/community.md).

For information on OpenWorm itself and contributing in general, see http://openworm.org and getting involved.

Building

Commits should be automatically built by continuous integration (CI), including branches and pull requests. Changes to the master branch will propagate to http://docs.openworm.org via the Read the Docs project.

Note that CI is automatically run every hour to pull in metadata from @OpenWorm repositories (specifically, root files matching .openworm.*). If changes are found, the CI itself will commit to master under the username @openworm-bot.

Local development

Requirements:

  • python (including pip)
  • make or pymake (pip install py-make)
(py)make install  # installs other dependencies
(py)make check    # basic tests
(py)make build    # creates static site/
(py)make serve    # hosts website locally (<http://127.0.0.1:8000>)