-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Tech: How to update the JavaDocs
The JSON-Java JavaDocs reside in the top-level /docs directory of the project.
This is a special-purpose directory that is known to GitHub pages. By referencing this project directory from http://stleary.github.io/JSON-java/, we can keep the source code and JavaDocs in the same repository.
JavaDocs should be updated whenever the source JavaDocs are changed. For now, this is a manual step performed by the project owner when PRs are merged. To update the JavaDocs and link to the oracle v7 docs, execute these commands (assumes the project repo is in the JSON-Java directory):
cd JSON-Java\src\main\java
javadoc -d \JSON-Java\docs -link https://docs.oracle.com/javase/7/docs/api/ org.json
Open a PR to replace the directory contents. To perform the initial link from stleary.github.io,
For more information see: https://github.blog/2016-08-22-publish-your-project-documentation-with-github-pages/