The open-source repo for docs.lenuage.io

• Generates beautiful documentation for laboîte project!

$ make install
$ make serve

Open up http://127.0.0.1:8000/ in your browser.

• Python 3.8 (package python3);
• pip package installer (package python3-venv);
• venv module (package python3-venv).

Make sure you have the required packages installed on your machine, then run some initialization commands:

$ make install

Run the built-in MkDocs dev-server:

$ make serve

Open up http://127.0.0.1:8000/ in your browser, and you'll see the home page being displayed.

Now, you can start editing source code in the folder /src/ (documentation source files are written in Markdown). Your browser will auto-reload and you should see your updated documentation immediately.

You should keep your development environment up to date. In any case, with each change of the requirements.in file, run:

$ make update-venv

MkDocs builds completely static HTML site which is hosted on GitHub pages.

To build the documentation in /docs/ folder, run:

$ make build

Commit, push, create a pull request, merge (or ask a team member to do so). Once your feature branch is merge into master branch, the documentation is available at https://docs.lenuage.io.

• Material for MkDocs: Material for MkDocs is a theme for MkDocs, a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

If you'd like to contribute, please raise an issue or fork the repository and use a feature branch. Pull requests are warmly welcome!

For the sake of simplicity, to ease interaction with the community, we use the GitHub flow for open-source projects. In a few words:

• The master branch is always stable and deployable;
• Tags from the master branch are considered as releases;
• Contributors have to fork or create a new feature-branch to work on (if they are allowed to in the original repository) and propose a pull request to merge their branch to master.

We use SemVer for versioning. See the CHANGELOG.md file for details.

Always use Black!

The code in this project is licensed under MIT license. See the LICENSE file for details.

• Baptiste Gaultier - bgaultier
• Vincent Rialland - vrialland
• Rémy Hubscher - Natim
• Mathieu Agopian - magopian
• Julien Lebunetel - jlebunetel