This repository contains source data for the online datasheet of TOWER. It uses Sphinx as a documentation generator altogether with reStructuredText as a lightweight markup language.

The documentation is hosted at Read The Docs and is automatically built on commit to the master branch.

Once built, the site is available at: https://tower.hardwario.com/

WARNING

You should always do ./docker.sh serve before pushing to the master branch and check for any warnings and errors.

Even if the build will succeed it will not show in most major internet browsers.

You can build your local version of the documentation. All you need is Docker Desktop and Git.

Follow these steps:

1. Open the terminal.

2. Clone the repository:

   git clone https://github.com/hardwario/doc-tower.git
   

3. Go to the repository:

   cd doc-tower
   

4. Build the Docker image:

   ./docker.sh build
   

Generate the documentation:

./docker.sh generate

The documentation output is in the directory build/html/.

You can also run the local web server that watches source files for changes and automatically regenerates the documentation:

./docker.sh serve

Once started, the documentation is available at: http:https://localhost:5500/

If you want to clean the output (contents of the build/ directory), just use:

./docker.sh clean

The source files are located in the source/ directory. Use an editor of your preference.

We recommend Visual Studio Code with these extensions:

• EditorConfig (to automatically follow .editorconfig file rules)
• reStructuredText (syntax support and highlight for .rst files)
• Grammarly (for spelling and grammar check)

Altogether with the ./docker.sh serve mode, you can have editor and the live browser preview side-by-side.

This project is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License - see the LICENSE file for details.

Made with ❤️ by HARDWARIO a.s. in the heart of Europe.