XeLabs/go-profiler-notes
2
0
Fork 0
mirror of https://github.com/DataDog/go-profiler-notes.git synced 2026-06-21 00:46:51 +08:00
Code Issues Projects Releases Wiki Activity

wip

Browse source
This commit is contained in:
Felix Geisendörfer 2022-12-27 14:41:07 +01:00
parent edb8883543
commit 2a3c2759b8
1 changed files with 7 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
CONTRIBUTING.md
View file

@ -1,22 +1,17 @@
# Contributing
To build the contents of this repository locally, follow the steps below.
## Local Development
1. Install sphinx and the read the docs theme
For local development, follow the steps below:
1. Install dependencies
```
pip install sphinx sphinx-rtd-theme
pip install sphinx sphinx-rtd-theme sphinx-autobuild sphinxemoji
```
2. Build the HTML
2. Run the development server
```
cd docs
make html
```
3. Open the HTML in your web browser
```
open _build/html/index.html
sphinx-autobuild docs/ docs/_build/html/
```