You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-1Lines changed: 21 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,9 +23,29 @@ The above commands will install [mkdocs](http://www.mkdocs.org/#installation) al
23
23
24
24
Since Cinder has not been upgraded in a while, it uses the changes in this [PR](https://github.com/chrissimpkins/cinder/pull/26) of Cinder found here: [twardoch/clinker-mktheme](https://github.com/twardoch/clinker-mktheme/tree/master).
25
25
26
+
## JavaDocs are Added When Releasing
27
+
28
+
**Note:** If you build and serve the site locally you will not be able to see the JavaDocs, you will only see simple place-holder pages (these are required or mkdocs will complain). The JavaDocs are added during the release process.
29
+
30
+
Running `make release` will save the docs currently in the master branch, and then replace the place-holder pages with the docs currently on master.
31
+
32
+
**To add new JavaDocs:**
33
+
* In src branch:
34
+
* Create new folder for the docs. e.g. `mkdir -p docs/java-docs/bullet-core/0.4.3/`
35
+
* Create a place-holder file. e.g. `cp docs/java-docs/bullet-core/0.4.2/index.html docs/java-docs/bullet-core/0.4.3/`
36
+
* Update mkdocs.yml - add a new line for the new sub-folder - see "JavaDocs" section of mkdocs.yml
37
+
* Commit these changes to the src branch. e.g. `git add -A && git commit -m "Added new JavaDocs"`
38
+
* Push src branch to remote
39
+
* Build a release: `make release` - this will leave you in the master branch with a new build ready NOT including the new docs you want to add
40
+
* In master branch after doing "make release" BEFORE pushing to remote:
41
+
* Create new folder for the docs. e.g.: `mkdir -p java-docs/bullet-core/0.4.3`
42
+
* Copy the contents of the new JavaDocs into the new folder. e.g. `cp -r ~/PATH-TO-NEW-DOCS/bullet-core/target/site/apidocs/* java-docs/bullet-core/0.4.3/`
43
+
* Commit these changes to the master branch. e.g. `git add -A && git commit -m "Build at abc123 with new JavaDocs"`
0 commit comments