github.com/juju/juju@v0.0.0-20240430160146-1752b71fcf00/scripts/schemadocs/README.md (about)

     1  # Schemadocs
     2  
     3  Schemadocs generates API documentation from the API facades schema json file.
     4  The output is a self contained html file that you can use in your browser to
     5  help navigate the types found with in juju.
     6  
     7  ### Generation
     8  
     9  To generate the html file, you need to ensure you have downloaded juju and have
    10  the files checked out correctly on your filesystem. Then run the following
    11  command (assuming you have go installed):
    12  
    13  ```
    14  make output.html
    15  ```
    16  
    17  Open the resulting output.html in your browser and enjoy.