Skip to content

Commit b23229d

Browse files
committed
Add a Building section to the CONTRIBUTING.md file, after the part about GitHub
1 parent 4e8db34 commit b23229d

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,27 @@ your clone of the originating `main` branch.
8585
Lastly, published copies of all the sections are available in the `main` branch of the originating
8686
repository for reference while revising.
8787

88+
## Building
89+
90+
The user guide uses [Sphinx](https://www.sphinx-doc.org/), a Python documentation
91+
tool. You must have a recent version of Python 3.6+ installed to build the project
92+
locally. It is also recommended having `make` (otherwise look at the commands used
93+
in `Makefile`).
94+
95+
```bash
96+
# Create and activate a virtual environment
97+
python -m venv venv
98+
source venv/bin/activate
99+
# Install the dependencies in your virtual environment
100+
(venv) pip install -e .[all]
101+
# Create the HTML to visualize locally
102+
(venv) make html
103+
(venv) firefox _build/index.html
104+
# Or you can start a serve that watches for local file changes
105+
(venv) make watch
106+
# Open <http://localhost:8000/> in your browser
107+
```
108+
88109
## Other Resources
89110

90111
General discussion of [Common Workflow Language][cwl-site] project

0 commit comments

Comments
 (0)