-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #495 from cunarist/uv-package-manager
Switch to `uv` for Python dependency resolution
- Loading branch information
Showing
14 changed files
with
43 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,3 +34,4 @@ target/ | |
# Others | ||
*.lock | ||
/documentation/site/ | ||
.python-version |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,15 @@ | ||
# Documentation | ||
|
||
In order to preview and build this documentation, you need to have Python and [Poetry](https://python-poetry.org/docs/) installed on your system. | ||
|
||
Activate the virtual environment. | ||
|
||
```bash | ||
poetry shell | ||
``` | ||
|
||
Install Python dependencies. | ||
|
||
```bash | ||
poetry install | ||
``` | ||
In order to preview and build this documentation, ensure you have [`uv`](https://docs.astral.sh/uv/getting-started/installation/), the modern Python package manager, installed on your system. | ||
|
||
Activate test server during development. | ||
|
||
```bash | ||
mkdocs serve | ||
```shell | ||
uv run mkdocs serve | ||
``` | ||
|
||
Activate test server during development. | ||
Build the documentation. | ||
|
||
```bash | ||
mkdocs build | ||
```shell | ||
uv run mkdocs build | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,11 @@ | ||
[tool.poetry] | ||
package-mode = false | ||
|
||
[tool.poetry.dependencies] | ||
python = "^3.10" | ||
mkdocs = "^1.6.1" | ||
mkdocs-material = "^9.5.34" | ||
mkdocs-awesome-pages-plugin = "^2.9.3" | ||
mkdocs-glightbox = "^0.4.0" | ||
mkdocs-git-revision-date-localized-plugin = "^1.2.9" | ||
[project] | ||
name = "rinf-documentation" | ||
version = "0.1.0" | ||
requires-python = ">=3.11" | ||
dependencies = [ | ||
"mkdocs~=1.6.1", | ||
"mkdocs-material~=9.5.34", | ||
"mkdocs-awesome-pages-plugin~=2.9.3", | ||
"mkdocs-glightbox~=0.4.0", | ||
"mkdocs-git-revision-date-localized-plugin~=1.2.9", | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters