File tree Expand file tree Collapse file tree 2 files changed +44
-1154
lines changed Expand file tree Collapse file tree 2 files changed +44
-1154
lines changed Original file line number Diff line number Diff line change 1+ # PDC Documentation
2+
3+ This walks you through setting up a local environment
4+ for building the PDC project documentation.
5+
6+ ---
7+
8+ ## Requirements
9+
10+ Ensure the following versions are installed on your system. Other versions
11+ may also work but have not been tested.
12+
13+ - ** Python 3.8.18**
14+ - ** pip 25.0.1**
15+ - ** Doxygen 1.13.2**
16+
17+ You can check the versions with:
18+ > ``` bash
19+ > python3.8 --version
20+ > pip --version
21+ > doxygen --version
22+ > ` ` `
23+
24+ ---
25+
26+ # # Setup Instructions
27+
28+ # ## 1. Clone the repository (if not already)
29+ ` ` ` bash
30+ git clone https://github.com/hpc-io/pdc.git
31+ cd pdc/docs
32+ ```
33+
34+ ### 2. Create Python environment install dependencies
35+ ``` bash
36+ python3.8 -m venv .venv
37+ source .venv/bin/activate
38+ pip install -r requirements.txt
39+ ```
40+
41+ ### 3. Build the html
42+ ``` bash
43+ python -m sphinx -T -b html -d _build/doctrees -D language=en source html
44+ ```
You can’t perform that action at this time.
0 commit comments