Home

For the source code visit the GitHub Repository.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

    C:.
    ├───.github
    │   └───workflows
    ├───.ipynb_checkpoints
    ├───.pytest_cache
    │   └───v
    │       └───cache
    ├───.ruff_cache
    │   ├───0.12.4
    │   └───0.12.7
    ├───.venv
    │   └───Scripts
    ├───.vscode
    ├───dist
    ├───docs
    │   └───img
    ├───json_pages
    │   └───.ipynb_checkpoints
    ├───legacy
    │   ├───files
    │   ├───mpcite
    │   │   └───__pycache__
    │   └───tests
    │       └───__pycache__
    ├───mpcite
    │   └───__pycache__
    ├───notebooks
    │   └───.ipynb_checkpoints
    ├───site
    │   ├───about
    │   ├───CHANGELOG
    │   ├───css
    │   ├───img
    │   ├───js
    │   ├───search
    │   └───webfonts
    ├───src
    │   └───mp_cite
    │       ├───.ipynb_checkpoints
    │       └───__pycache__
    ├───tests
    │   └───__pycache__
    └───test_json_pages
        └───.ipynb_checkpoints