Good documentation is very important.
We make and update the documentation based on Sphinx with some support of Markdown. So we can use both reStructuredText and Markdown files.
Required packages should be installed by
pip install "appfl[dev]" --upgrade
nbsphinx to add Jupyter notebooks to the doc, which requires
pandoc package. This pakcage may need to be manually installed from conda.
conda install -c conda-forge pandoc
The build command for documentation is:
cd appfl/docs make html
vscode can preview the docs.