mirror of
https://github.com/DataDog/go-profiler-notes.git
synced 2026-06-22 17:36:52 +08:00
wip
This commit is contained in:
parent
edb8883543
commit
2a3c2759b8
1 changed files with 7 additions and 12 deletions
|
|
@ -1,22 +1,17 @@
|
||||||
# Contributing
|
# 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
|
sphinx-autobuild docs/ docs/_build/html/
|
||||||
make html
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Open the HTML in your web browser
|
|
||||||
|
|
||||||
```
|
|
||||||
open _build/html/index.html
|
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue