Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Switch from Sphinx to Mkdocs for building documentation.
* docs: Switch to using markdown for the readme. * docs: Use html entity code instead of unicode character. * docs: Update README.md with the rest of the supported devices. * docs: Update CSS overrides to move back down to a 2 pixel border in the support table. * docs: Add $ to console section with pip install command. * docs: switch to shell code block * docs: Update legend to have all terms to make tables cleaner. * docs: Simply reference the glossary on the main page to make it render nicely for GitHub and PyPI. * docs: Add newline to glossary to make it render better on GitHub. * docs: Add link to glossary in readme. * docs: Substitute the links for documentation cross-references when building the documentation. * docs: Add memory profiling tools to diagnose build issues. * Switch to using mkdocs for documentation builds (#11) * docs: Switch to using mkdocs. * docs: Got basic code syntax highlighting working. * docs: Override the theme.js file to hide open/close buttons that don't need to be there. * docs: Added the ability to load in external code files to the docs. * docs: Updated examples in the basic_usage.md file. * docs: Update known words. * docs: Update links to repo. * docs: Update links to repos and update glossary plugin. * test: Got doc tests working. * test: Fixed the linkchecker test. * docs: Update tox config for docs. * docs: Start working on API docs. * docs: Update glossary plugin to use a version that supports unicode characters as glossary entries. * ci: Add file sorter for known_words.txt. * ci: Remove unneeded pre-commit hook. * docs: Add custom template for package files. * fix: Add missing init file. * docs: Updated all drivers with init methods to enable docs to build properly. * docs: Update the auto-generated commands to better render in the documentation. * docs: Implement a macro that will create mermaid class diagrams. * refactor: Move a class only used for type hinting into a new module and convert to a private class. * test: Fix a test based on new file paths. * docs: Remove unused css file and update links in python docstrings. * docs: Install the package when building docs to allow diagrams to be created properly. * docs: Update site path when building docs with tox. * docs: Update auto-generated python docstrings to render properly. * ci: Lock docutils version while the bad version is still on PyPI. * docs: Remove unneeded js files. * docs: Add links to API in various docs. * ci: Remove a pre-commit hook that is failing in some CI environments. * style: Use Python 3.8 syntax for type hinting. * docs: Update method of including python code snippets to allow mdformat to be used to format markdown files. * docs: Update config to correctly set the enabled key. * test: Update doc test config options. * docs: Ignore directories that start with double underscores. * docs: Update requirements for documentation so that code highlighting works properly. * build: Update all dependencies to be locked to major versions to prevent breaking changes from affecting the package. * ci: Update dependency updater script to lock requirements for testing and docs for repeatable builds. * docs: Update site URL, badge, and workflow to prep for move to ReadtheDocs. * docs: Update links. * fix: Update items found by Pull Request checks. * fix: Update links in readme for now. * docs: Update a few docs to render properly and with better linkage to other documentation. * docs: Update displayed text in some docstring cross-references.
- Loading branch information
