Skip to content
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.

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

Fix CONTRIBUTING docs #116

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 11 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ mamba env create -f environment.yml
mamba activate voici-dev

# Install package in development mode
pip install -e ".[dev,docs]"
pip install -e python/voici-core
pip install -e python/voici
```

`voici` follows a monorepo structure. To build all the packages at once:
Expand Down Expand Up @@ -82,22 +83,28 @@ This will trigger a GitHub Action that will run the UI tests automatically and p

First, follow the instructions above to set up a development environment.

Then, install the docs dependencies:

```bash
pip install myst-parser pydata-sphinx-theme sphinx sphinx-autobuild sphinxcontrib-video
```

Then, to build the documentation:

```bash
hatch run docs:build
sphinx-build -W -b html docs docs/build/html
```

In a separate terminal, start the documentation server:

```bash
hatch run docs:serve
python -m http.server --directory docs/build/html
```

You can also build and watch the documentation using the following command:

```bash
hatch run docs:watch
sphinx-autobuild -W -b html docs docs/build/html --host 0.0.0.0
```

Then open a web browser and navigate to `http://localhost:8000` to access the documentation.
Expand Down
8 changes: 0 additions & 8 deletions python/voici-core/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,6 @@ dev = [
"hatch",
]

docs = [
"myst-parser",
"pydata-sphinx-theme",
"sphinx",
"sphinx-autobuild",
"sphinxcontrib-video",
]

[project.scripts]
voici = "voici_core.app:main"

Expand Down
Loading
Loading