Skip to content

processing/processing4-javadocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 

Repository files navigation

Processing 4 Javadoc

This repository automatically generates the Javadoc for Processing 4 and hosts it on GitHub Pages at the following address:

👉 https://processing.github.io/processing4-javadocs/

How It Works

This repository uses a custom GitHub Actions workflow build-and-deploy-javadoc.yml.

The workflow runs on a weekly schedule (every Monday at 00:00 UTC) and it can also be triggered manually. It fetches the latest processing/processing4 release tag, checks out the corresponding commit, runs ant doc to generate the Javadocs, and deploys the output to GitHub Pages. The workflow also attempts to commit updated files into the repository’s doc/ folder, but it only creates a commit and push if the newly generated docs differ from what’s already stored.

This approach is reliable because it is fully independent of the main repository, not requiring extra coupling, permissions, or dispatch events between repositories. A minor downside is that updates only happen on the weekly schedule (unless triggered manually). This seems like an acceptable tradeoff given that the API and doc comments rarely change much between releases.

Legacy

The source files for the Processing 3 Javadocs can be found at https://github.com/processing/processing-javadocs

License

The Processing 4 reference is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC-BY-NC-SA-4.0).

About

This repository automatically generates the Javadoc for Processing 4 and hosts it on GitHub Pages

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •