Documentation

[amar-ox]

This is to discuss the documentation of the simulator. Below is a initial structure.
I'm thinking to use sphinx. Please provide feedback @yoursunny

docs/
├── index                   # Project landing page
├── install                  # Installation instructions
├── intro                    # Project motivation + background
├── tutorials/             # Step-by-step onboarding
│   ├── index 
│   ├── basic_run
│   ├── linear_topology_demo
│   ├── memory_allocation_demo
│   ├── swapping_demo
│   ├── purification_demo
│   ├── graph_topology_demo
│   ├── multiplexing_demo
│   └── reactive_vs_proactive
├── howto/                 # Focused configuration guides
│   ├── index
│   ├── customize_topology
│   ├── configure_routing
│   ├── configure_forwarding
│   ├── customize_repeater
├── explanation/           # Deep dives into theory, design
│   ├── index
│   ├── approach_and_simulator_design
│   ├── link_architectures
│   ├── entanglement_model
│   ├── qubit_lifecycle
│   ├── memory_management
│   └── timing_modes
├── reference/             # Autogenerated API docs
│   ├── index 
│   ├── modules
│   └── simulator_api

[yoursunny]

Almost every Python project publishes the documentation on Read the Docs.
They do use sphinx but have a specific theme.

[amar-ox]

Preparing for pip packaging of the project and a developer's guide. Here are planned changes to review: @yoursunny

• Use PEP 621 metadata in pyproject.toml and drop setup.py
• Adopt the src/ layout: move and rename ./qns to ./src/mqns
• Rename ./test to ./tests
• Should we enforce PEP 8 for code and Google Style Python Guide for Docstrings?

[yoursunny]

It's premature for pip packaging.
That should be deferred after the repository is made public.