This repository contains the source files used to generate the Lagrange documentation website. The generated documentation is available at the following URL:
https://opensource.adobe.com/lagrange-docs/
The documentation is rebuilt by GitHub Actions every time a new commit is pushed to docs branch.
Markdown files, except those generated automatically by Doxygen, can be edited directly through the GitHub website or locally after cloning the repository.
If you want to preview the resulting html page, follow the steps below on how to build the documentation locally.
The documentation uses the mkdocs-material theme. The theme comes with some extensions, e.g. Admonition. Use Admonition for things like notes, warnings, caveats, examples, etc.
For now images and other media are stored in subfolders in docs/
The gh-pages branch is reserved for the static html pages. It is advised to only clone the docs
branch (the default branch), rather than doing a full clone of the repository:
git clone git@github.com:adobe/lagrange-docs.git --single-branchRun the following conda command to install/update dependencies:
conda env update -f conda.yml
This will create/update a conda environment with the necessary prerequisites to build the website.
conda activate lagrange-website./generate.py <PATH_TO_LAGRANGE_ROOT>
Note: This will populate the following:
docs/ref/: html files generated by Doxygen
The following will run a local server at 127.0.0.1:8000
mkdocs serve
Alternatively, use mkdocs build to generate files into site folder
🚨 For reference only!
Note: This is for reference only, GitHub Actions does this automatically.
mkdocs gh-deploy -b gh-pages
will push to gh-pages branch automatically, which will update the website.
Contributions are welcomed! Read the Contributing Guide for more information.
The documentation and code snippets on this repository/website are licensed under the CC0 1.0 Universal License. See LICENSE for more information.