Shellmiao 9279d1873b Add projects | 1 vuosi sitten | |
---|---|---|
.. | ||
css | 1 vuosi sitten | |
docker | 1 vuosi sitten | |
js | 1 vuosi sitten | |
theme | 1 vuosi sitten | |
README.md | 1 vuosi sitten | |
gen_params_doc.py | 1 vuosi sitten | |
hook.py | 1 vuosi sitten | |
requirements.txt | 1 vuosi sitten |
We use setup.py to hook docs generation in readthedocs, just run
python doc/mkdocs/setup.py
At repo root, execute
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs sagewei0/mkdocs
to serve docs in http://localhost:8000
or
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs sagewei0/mkdocs build
to build docs to site
folder.
mkdocs-material
and servel plugins are needed to build this docs
Fisrt, create an python virtual environment
python3 -m venv "fatedocs"
source fatedocs/bin/activate
pip install -U pip
And then install requirements
pip install -r doc/mkdocs/requirements.txt
Now, use
mkdocs serve
at repo root to serve docs or
use
mkdocs build
at repo root to build docs to folder site
We use mkdocs-material to build our docs. Servel markdown extensions are really useful to write pretty documents such as admonitions and content-tabs.
Servel plugins are introdused to makes mkdocs-material much powerful:
mkdocstrings
automatic documentation from sources code. We mostly use this to automatic generate
params api
for federatedml
.
awesome-pages for powerful nav rule
i18n for multi-languege support
mkdocs-jupyter for jupyter format support
mkdocs-simple-hooks for simple plugin-in
<!-- {% include-examples "<name>" %} -->
extract all components's examples(pipeline, dsl v1, dsl v2) from examples
folder
<!-- {% include-example "???" %} -->
extract source code ???
from repo.