Mkdocs branch #101
Merged
Mkdocs branch #101
Conversation
This file contains 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
… and upload the resulting static files to a private website. I can't test it without uploading it, so this is the first test.
…endencies - this should be double checked by someone else as well. Also switched to using the material theme for mkdocs.
…he docs index. After trying several other plugins which didn't work I switched to using symbolic linking. This doensn't work on Windows, but I added a note in the readme for Windows folks. This seems to be the recommended solution by the mkdocs folks: mkdocs/mkdocs#1250.
…__call__ function is commented in the pdocs.
… This mostly involved adding carriage returns, changing indenting, and fixing headers.
…y some changes aren't showing up on the hosted site.
benlebrun
approved these changes
Nov 25, 2024
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 branch includes all of the work for created online documentation using mkdocs and https://github.com/probcomp/gen-website-private. It also include adding license information.