Mkdocs-based website to serve as high-level website and refer people to language-specific documentation.
To build website:
poetry install
poetry run mkdocs serve
To deploy: We have a couple manual steps because mkdocs gh-deploy
replaces
any existing content on the gh-pages
branch and we want an upsert that
doesn't touch the js/
or python/
directories, which are deployed separately.
poetry run mkdocs build
git checkout gh-pages
mv site/* ../
git add 404.html assets index.html sitemap.xml sitemap.xml.gz search stylesheets
git commit -m "New revision of top-level docs site"
git push