Migrate docs#21
Draft
stephwills wants to merge 11 commits into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR migrates the docs to use mkdocs instead of Jekyll, bringing it in line with the Paricia documentation.
Summary of changes:
enandes, and the config folder contains themkdocs.ymlfiles for configurationoverrides/assetscontains images and extra cssdocsdirectory for the jekyll site (hence large number of files deleted)mkdocs buildfor each language config, and then deploys the buildsitedir to agh-pagesbranchindex.htmlfile in the root directory, which gets copied into the builtsitesdir -- this just ensures the index page redirects to the English version of the index as defaultTo test locally install
requirements.txtand runmkdocs serve config/en/mkdocs.ymlormkdocs serve config/es/mkdocs.yml, then navitage tohttp://127.0.0.1:8000/riverlabs/.