Skip to content

csphoenix1/ludwig-docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ludwig documentation

Ludwig's documentation is build using MkDocs and the beautiful Material for MkDocs theme. In order to create Ludwig's documentation you have to install them:

pip install mkdocs<=1.2 mkdocs-material

Be sure that your installed version of Markdown>=3.0.1. Then generate api.md from source (from the src directory):

python code_doc_autogen.py

Test it (from the src directory):

mkdocs serve

Finally build the static website (from the src directory):

mkdocs build

It will create the static website in $LUDWIG_HOME/docs/.

About

Ludwig's documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 36.8%
  • SCSS 24.6%
  • Less 22.6%
  • CSS 12.5%
  • Python 2.6%
  • JavaScript 0.9%