File tree 1 file changed +10
-0
lines changed
1 file changed +10
-0
lines changed Original file line number Diff line number Diff line change @@ -47,3 +47,13 @@ You can now start a local webserver via:
47
47
bundle exec jekyll serve
48
48
```
49
49
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.
You can’t perform that action at this time.
0 commit comments