Skip to content

WELCOME on your amazing documation

Firmware ↵

Firmware

meme 1
meme 1

Ended: Firmware

Software ↵

SOFTWARE

Some intro ...

My amazing feature

Ended: Software

Tests Reports ↵

TEST 42

Ended: Tests Reports

Divers ↵

Changelog

Installation

This documentation works with Mkocs material. It based on markdown files, stocked in docs/ folder.
Different dependencies and the hierarchy of the documentation are describe in mkdocs.yml.

Once your .md files are written and the mkdocs.yml configured, this beautiful website can be built.

Install requirements

In a virtual environment

virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
Or directly in your python 
pip install -r requirements.txt

Run the docs

Once requirements are installed there are 2 possibilities, serve and build.

Serve

This is very useful when you are writing the doc, this will host the result of your doc with live reloading. You can start it with this command : 

mkdocs serve

$ INFO     -  Building documentation...
$ INFO     -  Cleaning site directory
$ INFO     -  Documentation built in 0.39 seconds
$ INFO     -  [10:23:55] Serving on http://127.0.0.1:8000/
$ INFO     -  [10:23:57] Browser connected: http://localhost:8000/installation.html

And you can access to the website documentation on http:/localhost:8000/

Build

The second one is when your are satisfied of your documentation, you can build it to host it on a production server for example.

mkdocs build

$ INFO     -  Cleaning site directory
$ INFO     -  Building documentation to directory: /home/berthet/Nancay/Nenufar/RadioGAGA/doc/site
$ INFO     -  Documentation built in 0.40 seconds

Examples

Some box

Info

Error

My custom warning

Question

Put some content in block

Click here to show content

Hello world

Tables

n° pin Name FPGA pin
b9 PF4 23A
b10 PF5 23B
b11 PF6 24A
b12 PF7 24B
b13 PE7 25A
b14 PE6 25B
b15 PE5 28B
b16 PE4 28A

Code block

script.py
import numpy as np 

print('Hello world')

Content Tabs

  • Sed sagittis eleifend rutrum
  • Donec vitae suscipit est
  • Nulla tempor lobortis orci
  1. Sed sagittis eleifend rutrum
  2. Donec vitae suscipit est
  3. Nulla tempor lobortis orci

Mathjax

\[ \operatorname{ker} f=\{g\in G:f(g)=e_{H}\}{\mbox{.}} \]

Checkbox

  • Lorem ipsum dolor sit amet, consectetur adipiscing elit
  • Vestibulum convallis sit amet nisi a tincidunt
    • In hac habitasse platea dictumst
    • In scelerisque nibh non dolor mollis congue sed et metus
    • Praesent sed risus massa
  • Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque

Ended: Divers

Back to top