File tree 1 file changed +21
-0
lines changed
1 file changed +21
-0
lines changed Original file line number Diff line number Diff line change @@ -85,6 +85,27 @@ your clone of the originating `main` branch.
85
85
Lastly, published copies of all the sections are available in the ` main ` branch of the originating
86
86
repository for reference while revising.
87
87
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
+
88
109
## Other Resources
89
110
90
111
General discussion of [ Common Workflow Language] [ cwl-site ] project
You can’t perform that action at this time.
0 commit comments