TFT_eSPI Documentation

Here you will find a documentation project for the TFT_eSPI library using Read the Docs. You are encouraged to help me with this documentation project.

Read the Docs Dashboard: https://beta.readthedocs.org/projects/doc-tft-espi/

---

📚docs/

The various files are mainly in Markdown format as the source of the documentation. They are "compiled" with MkDocs before being published on the Read the Docs website.

⚙️.readthedocs.yaml

Read the Docs Build configuration is stored in .readthedocs.yaml.

⚙️mkdocs.yml

This file allows the configuration of MkDocs behavior, particularly the implementation of Markdown or MkDocs extensions.

📍docs/requirements.txt

and docs/requirements.in

Python dependencies are pinned (uses pip-tools) here. Make sure to add your Python dependencies to requirements.txt or if you choose pip-tools, edit docs/requirements.in and remember to run pip-compile docs/requirements.in.

📜README.md

Contents of this README.md are visible on GitHub only and not included on the documentation index page.

⁉️Questions / comments

If you have questions related to this example, feel free to can ask them as a GitHub issue here.

🤝Contributing

You are encouraged to contribute to this documentation project. You can submit pull requests or report issues on the GitHub repository.

Example Project usage

This project has a standard MkDocs layout which is built by Read the Docs almost the same way that you would build it locally (on your own laptop!).

You can build and view this documentation project locally - we recommend that you activate a local Python virtual environment first:

# Install required Python dependencies (MkDocs etc.)
pip install -r docs/requirements.txt

# Run the mkdocs development server
mkdocs serve

Read the Docs tutorial

To get started with Read the Docs, you may also refer to the Read the Docs tutorial. It provides a full walk-through of building an example project similar to the one in this repository.

You can also find the Project documentation with Markdown.

---

©️ 2024 by Marc SIBERT
Some parts of the site are AI-powered outline courtesy of LLaMA