Web documentation generated using Markdown documents together with the Python module MkDocs. This documentation is intended to cover the main elements of the actual Throughput Database itself, including installation instructions and node types within the database.
There are also several data models presented to help showcase uses for the database, and the ways in which queries may be structured.
This project is an open project, and contributions are welcome from any individual. All contributors to this project are bound by a code of conduct. Please review and follow this code of conduct as part of your contribution.
- Simon Goring
- University of Wisconsin Madison
- Michael Lenard
- University of Michigan
Issues and bug reports are always welcome. Code clean-up, and feature additions can be done either through pull requests to project forks or branches.
All products of the Throughput Annotation Project are licensed under an MIT License unless otherwise noted.
Text files in this repository are parsed from Markdown using MkDocs, to generate a set of pages with navigation for use in displaying the Throughput documentation.
Mkdocs requires the use of Python. Instructions are available online to install Mkdocs. If Python 3.0+ and pip are both installed, then Mkdocs can be quickly installed using pip install mkdocs.
This repository is already set up as an Mkdocs project, so you can serve the pages locally using mkdocs serve, or render the whole site as a static webiste using mkdocs build. The serve command allows you to monitor your changes as you go. By default mkdocs serve serves the pages at localhost:8000.
Markdown files are arranged in folders within the [docs}(docs/) folder. Each folder represents a conceptual grouping of pages. The navigation is defined in the file mkdocs.yml, in the nav property.
mkdocs buildContinuous integration for the repository is managed using GitHub Actions with a module that builds the pages using mkdocs under an Ubuntu build. A failing build means that the current prod branch of the repository is not correctly set up to render a static Mkdocs site.
This project was developed using Python 3.8.10 in a Linux evironment (Ubuntu 20.04.3 LTS).
This project is self-contained (except for the requirements described above).
This project generates a documentation website. The main branch of the repository is live at https://throughput-ec.github.com/throughput_docs.