Skip to content
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
6 changes: 3 additions & 3 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ commands:
git status readthedocs_theme/ --porcelain
exit 1
fi
- run: pip install poetry
- run: poetry --no-ansi install
- run: poetry run pelican content -s publishconf.py
- run: pip install uv
- run: uv sync
- run: uv run pelican content -s publishconf.py
- run: npx html-validate --formatter codeframe output/

jobs:
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ node_modules/
__pycache__

output/

src/website.egg-info/
6 changes: 3 additions & 3 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ build:
python: "3.10"
nodejs: "14"
commands:
- pip install poetry
- poetry install
- pip install uv
- uv sync
- npm ci
- poetry run npm run build-html
- uv run npm run build-html
- mkdir -p _readthedocs/html/
- cp -r output/* _readthedocs/html/
2 changes: 1 addition & 1 deletion .tool-versions-example
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
nodejs 14.21.1
python 3.10.8
poetry 1.2.2
uv 0.7.8
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ Usage
Setting up your environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~

This package uses Poetry to manage Python dependencies and CSS and JS assets are
This package uses [uv](https://github.com/astral-sh/uv) to manage Python dependencies and CSS and JS assets are
built using a number of Node dependencies.

You will need the following requirements:

* Node.js version ``14``
* Python version ``3.10`` (any release ``>=3.6`` works)
* Poetry version ``1.2`` (any release ``>=1.1`` works)
* uv (Use ``asdf`` or see https://github.com/astral-sh/uv for installation instructions)

Using ``asdf`` is recommended but optional. The ``asdf`` commands below will
install all system level dependencies for you, including Poetry.
install all system level dependencies for you.

.. code-block:: console

Expand All @@ -47,7 +47,7 @@ manually, you can install all package level dependencies with:

.. code-block:: console

$ poetry install
$ uv sync
$ npm install

Local development and authoring
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"clean-html": "rm -rfv output/*; exit 0",
"build": "npm run build-assets && npm run build-html",
"build-assets": "npm run clean-assets && webpack --mode=production --progress --colors",
"build-html": "npm run clean-html && pelican content",
"build-html": "npm run clean-html && uv run pelican content",
"dev": "webpack-dev-server --mode=development",
"livereload": "npm run dev",
"lint": "prettier --check 'src/**' '*.js' '*.json'",
Expand Down
Loading