Skip to content
  • Jean-Christophe Fillion-Robin's avatar
    Add documentation skeleton · ebbfc1a5
    Jean-Christophe Fillion-Robin authored
    Steps:
    
    * Generate initial sphinx project:
    
    ```
    $ mkdir docs & cd docs
    $ sphinx-quickstart
    ```
    
    * Add `requirements.txt`
    
    ```
    $ echo "furo
    myst-parser[linkify]
    sphinx
    sphinx-design" > requirements.txt
    ```
    
    * Edit `conf.py`
      - replacing single quotes with double quotes
      - setting these variables:
        - `extensions`
        - `myst_enable_extensions`
        - `myst_heading_anchors`
        - `html_theme` (change theme to "furo")
    
    * Delete `index.rst`
    
    * Add `README.md` and `overview.md` (itself including `README.md`)
    ebbfc1a5