Skip to content
Open
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
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ This repository generates the documentation hosted at [docs.hello-robot.com](htt
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`.

## Setup for Documentation Development
In order to create a development environment on a 20.04 Ubuntu machine:
In order to create a development environment on a >=20.04 Ubuntu machine:
```
cd ~/repos
git clone https://github.com/hello-robot/hello-robot.github.io
cd hello-robot.github.io
./install.sh
uv sync # Or python3 venv && source venv/bin/activate && pip3 install -e .

# choose a version of the documentation (e.g. 0.3)
git checkout 0.3
git submodule init
Expand All @@ -23,6 +24,7 @@ The documentation is organized on versioned branches:
/repos/hello-robot.github.io$ git branch
0.1
0.2
0.3
gh-pages
```
This allows for the development of new documentation under a new version while hosting the stable documentation as default.
Expand All @@ -47,7 +49,8 @@ git push

```commandline
cd ~/repos/hello-robot.github.io
mike serve
source ~/.venv/bin/activate
mkdocs serve
Starting server at http://localhost:8000/
Press Ctrl+C to quit.
```
Expand Down
22 changes: 22 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[project]
name = "hello-robot-github-io"
version = "0.1.0"
description = "This repository generates the documentation hosted at [docs.hello-robot.com](https://docs.hello-robot.com)."
readme = "README.md"
requires-python = ">=3.10"
dependencies = [
"jinja2==3.0.3",
"mike>=2.1.3",
"mkdocs>=1.6.1",
"mkdocs-glightbox>=0.5.2",
"mkdocs-include-markdown-plugin>=7.2.0",
"mkdocs-jupyter>=0.25.1",
"mkdocs-material==9.6.9",
"mkdocs-monorepo-plugin>=1.1.2",
"mkdocs-redirects>=1.2.2",
"mkdocs-same-dir>=0.1.3",
"mkdocs-simple-plugin>=3.2.4",
"mkdocstrings-python-legacy>=0.2.7",
"pygments>=2.19.2",
"pytkdocs[numpy-style]>=0.16.5",
]
14 changes: 0 additions & 14 deletions requirements.txt

This file was deleted.

Loading