This repository hosts official SpotBugs manual built by Sphinx.
We provide a Dockerfile and a script file to build documents.
After installation of docker 1.13.1 or later, simply kick ./build.sh then it will build Docker image and run commands in it. You can find generated HTML pages under .build/html directory.
To deploy changes to manual site, just merge your changes to master branch then it will be deployed to latest page.
When you need maintainer access to Read the Docs, please contact with @KengoTODA.
For each supported language, We need independent ReadTheDocs project like below:
Please create similar project for new language, and configure translations setting for spotbugs project. For detail, visit official document.
When we want to add active versions for documents, visit version page. For detail, visit official document.