https://github.com/openworm/openworm_docs
Documentation for OpenWorm, i.e. docs.openworm.org
https://github.com/openworm/openworm_docs
Last synced: 11 months ago
JSON representation
Documentation for OpenWorm, i.e. docs.openworm.org
- Host: GitHub
- URL: https://github.com/openworm/openworm_docs
- Owner: openworm
- Created: 2013-09-13T16:34:53.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2024-07-02T18:21:31.000Z (almost 2 years ago)
- Last Synced: 2025-04-07T23:02:18.758Z (about 1 year ago)
- Language: Python
- Homepage: http://docs.openworm.org
- Size: 21.8 MB
- Stars: 44
- Watchers: 35
- Forks: 26
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# openworm_docs
Documentation for OpenWorm, hosted at .
[![Make Documentation][CI-badge]][CI]
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][RTD-proj].
More information on contributing to this documentation is available at
[docs.openworm.org/community][Contributing] (which is generated from
[docs/community.md][Contributing-local]).
For information on OpenWorm itself and contributing in general, see
and [getting involved].
[RTD-proj]: https://readthedocs.org/projects/dev-openworm-docs
[Contributing]: http://docs.openworm.org/en/latest/community#contributing-to-the-openworm-documentation
[Contributing-local]: docs/community.md
[getting involved]: http://openworm.org/get_involved.html
[CI-badge]: https://github.com/openworm/openworm_docs/actions/workflows/mkdocs.yml/badge.svg
[CI]: https://github.com/openworm/openworm_docs/actions/workflows/mkdocs.yml
## Building
Commits should be automatically built by continuous integration (CI), including
branches and pull requests. Changes to the `master` branch will propagate to
via [the Read the Docs project][RTD-proj].
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 ()
```