Skip to content

Docs: Update developer workflow to prioritize Devcontainers and local setup using uv #1790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tharun-mk wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs: Update developer workflow to prioritize Devcontainers and local setup using uv #1790

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 35 additions & 6 deletions docs_sphinx/developer/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,41 @@ This section is intended as a guide to how Brian functions internally for
people developing Brian itself, or extensions to Brian. It may also be of some
interest to others wishing to better understand how Brian works internally.

If you use `VS code <https://code.visualstudio.com/>`_ as your development
environment, it will offer to automatically build a Brian development
`Docker <https://www.docker.com/>`_ container when you open the repository,
with all the required dependencies installed and configured. Further
`documentation <https://github.com/brian-team/brian2/blob/master/.devcontainer/README.md>`_
for this approach can be found in the ``.devcontainer`` directory.
Setting up a development environment
-------------------------------------

Option 1: Devcontainers (Highly Recommended)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The easiest and most reliable way to set up a development environment is to use
`VS Code Devcontainers <https://code.visualstudio.com/docs/devcontainers/containers>`_.
When you open the Brian repository in
`VS Code <https://code.visualstudio.com/>`_, it will offer to automatically
build a `Docker <https://www.docker.com/>`_ container with all the required
dependencies installed and configured — no manual setup needed.

For full details, see the
`Devcontainer README <https://github.com/brian-team/brian2/blob/master/.devcontainer/README.md>`_
in the ``.devcontainer`` directory.

Option 2: Local Setup using ``uv``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you prefer a local setup without Docker, you can use
`uv <https://docs.astral.sh/uv/>`_ to install Brian in development mode.
``uv`` resolves all dependencies directly from the existing ``pyproject.toml``
file, keeping the repository clean without needing external dependency files.

1. `Install uv <https://docs.astral.sh/uv/getting-started/installation/>`_ if
you haven't already.
2. From the root of the repository, run:

.. code-block:: bash

uv add --dev --editable .[docs,test]

This will install Brian along with all documentation and testing
dependencies in an editable (development) mode.

.. toctree::
:maxdepth: 2
Expand Down