Skip to content

Clarify if doc/ and .gitignore should be included in project structure

In section 4.3 Project structure and organisation, should we explicitly mention the presence of a doc/ directory (for documentation) in the recommended project layout?

Current example:

project_name/
    ├── pyproject.toml
    ├── README.md
    ├── environment.yml / requirements.txt
    ├── src/project_name/
    │   ├── init.py
    │   ├── main_module.py
    ├── tests/
    │   ├── test_main.py
    ├── data/ (if applicable)
    │   └── ... └── notebooks/ (for exploratory work)

Possibe update:

project_name/
    ├── pyproject.toml
    ├── README.md
    ├── environment.yml / requirements.txt
    ├── src/project_name/
    │   ├── init.py
    │   ├── main_module.py
    ├── tests/
    │   ├── test_main.py
    ├── doc/
    │   ├── conf.py
    │   ├── index.rst
    ├── data/ (if applicable)
    │   └── ... └── notebooks/ (for exploratory work)

Additionally, should we also suggest including a .gitignore file in the project root, or that considered too obvious to mention?