mirror of
https://github.com/DataDog/go-profiler-notes.git
synced 2026-06-22 17:36:52 +08:00
Add Contributing
This commit is contained in:
parent
a95329bdb7
commit
d4b4c04bac
1 changed files with 22 additions and 0 deletions
22
CONTRIBUTING.md
Normal file
22
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
To build the contents of this repository locally, follow the steps below.
|
||||||
|
|
||||||
|
1. Install sphinx and the read the docs theme
|
||||||
|
|
||||||
|
```
|
||||||
|
pip install sphinx sphinx-rtd-theme
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Build the HTML
|
||||||
|
|
||||||
|
```
|
||||||
|
cd docs
|
||||||
|
make html
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Open the HTML in your web browser
|
||||||
|
|
||||||
|
```
|
||||||
|
open _build/html/index.html
|
||||||
|
```
|
||||||
Loading…
Reference in a new issue