README.md 810 Bytes
Newer Older
Whitney Armstrong's avatar
Whitney Armstrong committed
1
# IP6 Collaboration
Sylvester Joosten's avatar
Sylvester Joosten committed
2

Dmitry Romanov's avatar
Dmitry Romanov committed
3
Main documentation for the EIC@IP6 collaboration
Whitney Armstrong's avatar
Whitney Armstrong committed
4
https://eic.phy.anl.gov/ip6
Dmitry Romanov's avatar
Dmitry Romanov committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

# Documentation

To Build the documentation on your local machine:

## Requirments:

- [Sphinx](http://www.sphinx-doc.org/en/master/) - Python documentation generator
- [Read the Docs Sphinx Theme](https://sphinx-rtd-theme.readthedocs.io/en/stable/) - Theme for final output
- [recommonmark](https://github.com/miyakogi/m2r) - Markdown to reStructuredText


```
pip install sphinx sphinx_rtd_theme recommonmark sphinx-autobuild
```

## Building

```bash

# from project root
sphinx-autobuild docs docs/_build/html

# from docs root
sphinx-autobuild . _build/html
```


## Read the docs

Whitney Armstrong's avatar
Whitney Armstrong committed
35
The documentation is available at https://eic.phy.anl.gov/ip6
Dmitry Romanov's avatar
Dmitry Romanov committed
36

Whitney Armstrong's avatar
Whitney Armstrong committed
37
It updates automatically when changes are pushed do the repo