Skip to content

Commit 0030707

Browse files
Added a pyproject.toml. Updated the README to use mkdocs serve instead of mike serve (#17)
* Added a pyproject.toml. Updated the README to use mkdocs serve instead of mike serve * Update README.md to say use `mike serve` for 0.1 and 0.2 docs
1 parent 21cf10c commit 0030707

File tree

4 files changed

+1935
-17
lines changed

4 files changed

+1935
-17
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@ This repository generates the documentation hosted at [docs.hello-robot.com](htt
55
The content largely lives inside of independent repositories that include their own MkDocs site generation information. This repo has the role of integrating these independent repositories together using the plugin `mkdocs-monorepo-plugin`.
66

77
## Setup for Documentation Development
8-
In order to create a development environment on a 20.04 Ubuntu machine:
8+
In order to create a development environment on a >=20.04 Ubuntu machine:
99
```
1010
cd ~/repos
1111
git clone https://github.com/hello-robot/hello-robot.github.io
1212
cd hello-robot.github.io
13-
./install.sh
13+
uv sync # Or python3 venv && source venv/bin/activate && pip3 install -e .
14+
1415
# choose a version of the documentation (e.g. 0.3)
1516
git checkout 0.3
1617
git submodule init
@@ -23,6 +24,7 @@ The documentation is organized on versioned branches:
2324
/repos/hello-robot.github.io$ git branch
2425
0.1
2526
0.2
27+
0.3
2628
gh-pages
2729
```
2830
This allows for the development of new documentation under a new version while hosting the stable documentation as default.
@@ -47,7 +49,8 @@ git push
4749

4850
```commandline
4951
cd ~/repos/hello-robot.github.io
50-
mike serve
52+
source ~/.venv/bin/activate
53+
mkdocs serve # Note: Use `mike serve` for 0.1 and 0.2 docs.
5154
Starting server at http://localhost:8000/
5255
Press Ctrl+C to quit.
5356
```

pyproject.toml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[project]
2+
name = "hello-robot-github-io"
3+
version = "0.1.0"
4+
description = "This repository generates the documentation hosted at [docs.hello-robot.com](https://docs.hello-robot.com)."
5+
readme = "README.md"
6+
requires-python = ">=3.10"
7+
dependencies = [
8+
"jinja2==3.0.3",
9+
"mike>=2.1.3",
10+
"mkdocs>=1.6.1",
11+
"mkdocs-glightbox>=0.5.2",
12+
"mkdocs-include-markdown-plugin>=7.2.0",
13+
"mkdocs-jupyter>=0.25.1",
14+
"mkdocs-material==9.6.9",
15+
"mkdocs-monorepo-plugin>=1.1.2",
16+
"mkdocs-redirects>=1.2.2",
17+
"mkdocs-same-dir>=0.1.3",
18+
"mkdocs-simple-plugin>=3.2.4",
19+
"mkdocstrings-python-legacy>=0.2.7",
20+
"pygments>=2.19.2",
21+
"pytkdocs[numpy-style]>=0.16.5",
22+
]

requirements.txt

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)