Add Mkdocs as documentation framework #17
Merged
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.
Copying over the basic setup of documentation from dolphin. It uses MkDocs, and the MkdocStrings for autogenerating the reference material. Once you install the requirements in
![image](https://private-user-images.githubusercontent.com/8291800/332576235-a6b09199-c7cb-4f06-9230-f9ed79944a96.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkxODAyNTMsIm5iZiI6MTczOTE3OTk1MywicGF0aCI6Ii84MjkxODAwLzMzMjU3NjIzNS1hNmIwOTE5OS1jN2NiLTRmMDYtOTIzMC1mOWVkNzk5NDRhOTYucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTBUMDkzMjMzWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9YmVlZWE4MWEwMTNlYTVjNjc3MjNjOWYyNzBlYWYzY2VmNDU3YTVhMDZmM2EzODJiNjU1MDc5ZjQ2MjNhMTQ3MCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.ByDqqfcaDPgEkEAYAxmRwPBlVgyft1KtmogKSxPMPLc)
docs/requirements.txt
, you can locally view the docs withmkdocs serve
:Other features:
docs/references.bib
. So in docstrings or other markdown docs, we can add@[Pepe2006ExtensionMinimumCost]
and it'll look like this: