Skip to content
Snippets Groups Projects
README.md 621 B
Newer Older
  • Learn to ignore specific revisions
  • # [Self Data Grandlyon Documentation](https://doc.self-data.alpha.grandlyon.com/)
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    ## Install dependencies
    
    
    ```sh
    pip install -r  ./requirements/docs.txt
    ```
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    ## Commands
    
    
    - `mkdocs serve` - Start the live-reloading docs server.
    - `mkdocs build` - Build the documentation site.
    - `mkdocs help` - Print this help message.
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    ## Files hierarchy
    
    When adding new pages, add it respectively to the [mkdocs.yml](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/self-data-technical-doc/-/blob/master/mkdocs.yml#L46)
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    
    ## Mkdocs Reference
    
    [mkdocs features](https://squidfunk.github.io/mkdocs-material/reference/)