Skip to content

Commit e4df4dd

Browse files
committed
Added information about how to build and preview the docs and a requirments file to install all the dependencies you need to build the docs.
1 parent 243cd56 commit e4df4dd

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing to RFDpoly
2+
3+
## Code Contributions
4+
5+
## Documentation Contributions
6+
7+
To preview the changes you made to the documentation before making a Pull Request you will need to
8+
install a few dependencies which can be done via
9+
```
10+
uv pip install -r docs/docs_requirements.txt
11+
```
12+
13+
To build the documentation, navigate to `docs` and run:
14+
```
15+
make html
16+
```
17+
You will then be able to see the generated HTML pages in `build/html`

docs/docs_requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
sphinx>=8.2.3
2+
furo>=2025.9.25
3+
myst-parser>=4.0.1
4+
sphinx-copybutton>=4.0.1

0 commit comments

Comments
 (0)