ccpem / ccpem/empiarreader

Information about documentation in docs

Open
#50 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
14
Forks
4
PR merge metrics
No merged PRs in 30d

Description

- Read the docs builds here: https://empiarreader.readthedocs.io/en/latest/
- PRs make a preview of how the docs will look on RtD
- Build docs by hand in usual way for sphinx (NB these instructions may be wrong):
- make sure `pip install empiarreader[doc]` is installed (or `pip install .[doc]` if installing locally)
- cd into `docs`
- `make html`
- open index.html in the build directory
- TODO - note the above in some developer docs

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.