Document how to setup the development environment for contributing to picard-docs

ExportXMLWordPrintable

    • Type: Task
    • Resolution: Unresolved
    • Priority: Normal
    • None
    • Affects Version/s: None
    • Component/s: Documentation
    • None

      Currently there are no instructions for how to setup the development environment for contributors looking to help with documentation for the picard-docs repo.

      The picard repo itself has clear steps on how to setup the development environment in its CONTRIBUTING.md file, however the picard-docs CONTRIBUTING.md provides no such instructions.

      A technical setup section that mirrors the picard repo CONTRIBUTING.md should be added that details the steps needed for setting up the development.

      For example

      ### 1. Install uv (Recommended)

[uv](https://docs.astral.sh/uv/) is an extremely fast Python package manager:

```bash
# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

###2. Set Up Documentation Environment

```bash
# Clone and enter the repository
git clone https://github.com/metabrainz/picard-docs.git
cd picard-docs

# Create virtual environment
uv venv
source .venv/bin/activate  # macOS/Linux
# .venv\Scripts\activate.bat  # Windows

# Install the requirements.txt
uv pip install -r requirements.txt

# Build the project and launch the sphinx server
uv run sphinx-autobuild ./ build/ # Builds the sphinx documentation and starts a server at http://127.0.0.1:8000 for previewing documentation of changes

            Assignee:
            jean-luc-picard
            Reporter:
            jean-luc-picard
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:

                Version Package