Skip to content

caracal-pipeline/caracal-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 

Repository files navigation

How to update the Caracal documentation

Make sure that you've got the latest caracal and caracal_docs in the same parent directory.

Go into the caracal_docs directory and type the following (having installed some python modules to be listed here soon):

python make_caracal_docs.py
cd sphinx
make html
cd ../

Then commit and push your changes to this repository.

And you're done! The readthedocs page https://caracal.readthedocs.io will be updated automatically.