Generate documentation site using Mkdocs #180
Merged
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
eliotwrobson
approved these changes
Oct 25, 2023
There was a problem hiding this comment.
Looks great so far, thanks for your work @lewiuberg ! One small question but generally ok with being generous merging to this feature branch.
eliotwrobson
added a commit
that referenced
this pull request
Dec 29, 2023
* WIP: Converting to mkdocs * Starting point for gen doc by using docstrings (#180) * Updated mkdocs config (#187) * Started adding DFA docstrings (#188) * Changed excludes * Started adding docs for DFA class * Updated docstring * Adding docstrings * DFA ops docstrings * Added a bunch of docstrings * Even more DFA docstrings * Docstrings on most of the DFA class * Finished up DFA docstrings * NFA docstrings * Update nfa.py * Starting GNFA docstring * Added FA docstring * Update regex.py * Added PDA docstrings * Adding docstrings onto the TM class * Updated docstrings * Added FA docs pages * Added docs pages for most classes. * Removed old files * Added back examples * Moved migration guide to docs page * Adding onto docstrings. * Added onto docstrings * Modified DPDA docstring * Added NPDA example to docstring * Even better docstrings * Minor restructuring docs site * Update mkdocs.yml Co-authored-by: Caleb Evans <caleb@calebevans.me> * Fixed 404 page * Removed author comments * Added logo * New logo --------- Co-authored-by: Lewi Uberg <lewiuberg@icloud.com> Co-authored-by: Caleb Evans <caleb@calebevans.me>
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.
Starting point for using mkdocs to generate documentation site.