Skip to content

Commit 377c770

Browse files
jomayerijeffra
andauthored
Updating docs README (#2587)
* Updating docs README with API update procedure. * Addressing comments. Co-authored-by: Jeff Rasley <[email protected]>
1 parent ccb8eb8 commit 377c770

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,13 @@ You can now start a local webserver via:
4747
bundle exec jekyll serve
4848
```
4949
The website should now be accessible at [http://localhost:4000](http://localhost:4000)
50+
51+
52+
## Update the Readthedocs.io API documentation
53+
Use the following steps to update the public API documentation.
54+
55+
1. Make your documentation changes and push them to the rtd-staging branch. This will rebuild the docs in the staging branch.
56+
**NOTE**: It is acceptable to force push to this branch to overwrite previous changes.
57+
2. View the result of the result of the build [here](https://readthedocs.org/projects/deepspeed/builds/)
58+
3. Once the build is complete view the newly modified API documentation [here](https://deepspeed.readthedocs.io/en/rtd-staging/)
59+
4. Once you are satisfied with the changes create a new branch off of rtd-staging to push into master.

0 commit comments

Comments
 (0)