WIP: Converting to mkdocs

.venv

@@ -0,0 +1 @@
+automata-hnfz

docs/about.md

@@ -0,0 +1,3 @@
+# About
+
+Automata is a Python 3 library which implements the structures and algorithms for finite automata, pushdown automata, and Turing machines.

docs/index.md

@@ -0,0 +1,54 @@
+---
+author: "Lewi Lie Uberg"
+---
+
+# Automata <!-- omit in toc -->
+
+_Copyright 2016-2022 Caleb Evans_
+_Released under the MIT license_
+
+[![tests](https://github.com/caleb531/automata/actions/workflows/tests.yml/badge.svg)](https://github.com/caleb531/automata/actions/workflows/tests.yml)
+[![Coverage Status](https://coveralls.io/repos/caleb531/automata/badge.svg?branch=main)](https://coveralls.io/r/caleb531/automata?branch=main)
+
+Automata is a Python 3 library which implements the structures and algorithms
+for finite automata, pushdown automata, and Turing machines. The library
+requires Python 3.7 or newer.
+
+Huge thanks to [@YtvwlD][YtvwlD], [@dengl11][dengl11], [@Tagl][Tagl],
+[@lewiuberg][lewiuberg], [@CamiloMartinezM][CamiloMartinezM],
+[@abhinavsinha‑adrino][abhinavsinha-adrino], and [@eliotwrobson][eliotwrobson]
+for their invaluable code contributions to this project! 🎉
+
+[YtvwlD]: https://github.com/YtvwlD
+[dengl11]: https://github.com/dengl11
+[Tagl]: https://github.com/Tagl
+[lewiuberg]: https://github.com/lewiuberg
+[CamiloMartinezM]: https://github.com/CamiloMartinezM
+[abhinavsinha-adrino]: https://github.com/abhinavsinha-adrino
+[eliotwrobson]: https://github.com/eliotwrobson
+
+## Migrating to v7
+
+If you wish to migrate to Automata v7 from an older version, please follow the
+[migration guide][migration].
+
+<!-- the below link must be an absolute URL to be functional in the PyPI README -->
+
+[migration]: https://github.com/caleb531/automata/blob/main/MIGRATION.md
+
+## Installing
+
+You can install the latest version of Automata via pip:
+
+```sh
+pip install automata-lib
+```
+
+## API
+
+Please refer to [the official API Documentation][docs] in the `docs/` directory
+of the GitHub repository.
+
+<!-- the below link must be an absolute URL to be functional in the PyPI README -->
+
+[docs]: https://github.com/caleb531/automata/blob/main/docs/README.md

docs/people.md

@@ -0,0 +1,12 @@
+# People
+
+## Team
+
+[caleb531](https://github.com/caleb531)<br/>
+[lewiuberg](https://github.com/lewiuberg)<br/>
+[eliotwrobson](https://github.com/eliotwrobson)<br/>
+[YtvwlD](https://github.com/YtvwlD)<br/>
+[dengl11](https://github.com/dengl11)<br/>
+[Tagl](https://github.com/Tagl)<br/>
+[CamiloMartinezM](https://github.com/CamiloMartinezM)<br/>
+[abhinavsinha-adrino](https://github.com/abhinavsinha-adrino)<br/>

mkdocs.yml

@@ -0,0 +1,150 @@
+site_name: Automata
+site_description: Automata is a Python 3 library which implements the structures and algorithms for finite automata, pushdown automata, and Turing machines.
+site_url: https://automata.site.to.be.created.org
+repo_url: https://github.com/caleb531/automata
+repo_name: automata
+edit_uri: blob/main/docs/
+# author: Lewi Lie Uberg
+# multiple authors:
+authors:
+  - caleb531: https://github.com/caleb531
+  - lewiuberg: https://github.com/lewiuberg
+  - eliotwrobson: https://github.com/eliotwrobson
+  - YtvwlD: https://github.com/YtvwlD
+  - dengl11: https://github.com/dengl11
+  - Tagl: https://github.com/Tagl
+  - CamiloMartinezM: https://github.com/CamiloMartinezM
+  - abhinavsinha-adrino: https://github.com/abhinavsinha-adrino
+theme:
+  name: material
+  palette:
+    - scheme: default
+      primary: indigo
+      accent: deep purple
+      toggle:
+        icon: material/lightbulb
+        name: Switch to dark mode
+    - scheme: slate
+      primary: indigo
+      accent: deep purple
+      toggle:
+        icon: material/lightbulb-outline
+        name: Switch to light mode
+  features:
+    - search.suggest
+    - search.highlight
+    - toc.integrate
+    - navigation.top
+    - navigation.indexes
+    - navigation.tabs
+  # - navigation.tabs.sticky
+  # - navigation.tracking
+  # - navigation.expand
+  # - navigation.sections
+  # - header.autohide
+  icon:
+    repo: fontawesome/brands/github
+  logo: assets/img/logo.svg
+  favicon: assets/img/favicon.ico
+  language: en
+plugins:
+  - search:
+      separator: '[\s\-\.]'
+      min_length: 2
+      indexing:
+        "full"
+        # media_type: print
+        # enabled_if_env: ENABLE_PDF_EXPORT
+  - macros:
+      enabled_if_env: ENABLE_PDF_EXPORT
+markdown_extensions:
+  - toc:
+      permalink: true
+  - pymdownx.highlight:
+      # auto_title: true
+      # anchor_linenums: true
+      # linenums: true
+      # linenums_style: pymdownx-inline
+  - pymdownx.tasklist:
+      clickable_checkbox: true
+      custom_checkbox: true
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.critic
+  - pymdownx.caret
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.tilde
+  - pymdownx.betterem
+  - admonition
+  - pymdownx.details
+  - footnotes
+  - attr_list
+  - md_in_html
+  - tables
+extra:
+  social:
+    - icon: fontawesome/solid/network-wired
+      link: https://uberg.me
+      name: Author website
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/in/lewiuberg/
+      name: Author on LinkedIn
+    - icon: fontawesome/brands/github
+      link: https://github.com/lewiuberg
+      name: Author on GitHub
+    - icon: fontawesome/brands/medium
+      link: https://lewiuberg.medium.com
+      name: Author on Medium
+    - icon: fontawesome/brands/python
+      link: https://pypi.org/user/lewiuberg/
+      name: Author on PyPI
+    - icon: fontawesome/brands/stack-overflow
+      link: https://stackoverflow.com/users/10685529/lewi-uberg
+      name: Author on Stack Overflow
+# extra_css:
+#   - stylesheets/extra.css
+# extra_javascript:
+#   - javascripts/extra.js
+copyright: Copyright © 2016 - 2023 Caleb Evans
+nav:
+  - API Documentation:
+      - Class Automaton:
+          - class-automaton.md
+      - Finite Automaton (FA):
+          - fa/class-fa.md
+          - Deterministic (DFA):
+              - fa/class-dfa.md
+          - Non-Deterministic (NFA):
+              - fa/class-nfa.md
+          - Generalized Non-Deterministic (GNFA):
+              - fa/class-gnfa.md
+          - Examples:
+              - fa/examples.md
+      - Pushdown Automaton (PDA):
+          - pda/class-pda.md
+          - Deterministic (DPDA):
+              - pda/class-dpda.md
+          - Non-Deterministic (NPDA):
+              - pda/class-npda.md
+      - Turing Machine (TM):
+          - tm/class-tm.md
+          - Deterministic (DTM):
+              - tm/class-dtm.md
+          - Non-Deterministic (NTM):
+              - tm/class-ntm.md
+          - Multi-Tape Non-Deterministic (MNTM):
+              - tm/class-mntm.md
+      - Regular Expressions:
+          - regular-expressions.md
+      - Base exception classes:
+          - base-exception-classes.md
+      - Turing machine exceptions:
+          - tm/tm-exception-classes.md
+  - People: /people/
+  - About: /about/

requirements.docs.txt

@@ -0,0 +1,3 @@
+mkdocs==1.4.2
+mkdocs-material==9.1.9
+mkdocs-macros-plugin==0.7.0