Skip to content

Commit 3d647bc

Browse files
committed
Fixed: Github button
1 parent 81e5239 commit 3d647bc

File tree

4 files changed

+22
-44
lines changed

4 files changed

+22
-44
lines changed

Docs/Makefile

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,33 @@
11
# Minimal makefile for Sphinx documentation
2-
#
32

43
# You can set these variables from the command line, and also
54
# from the environment for the first two.
6-
SPHINXOPTS ?=
7-
SPHINXBUILD ?= sphinx-build
8-
SOURCEDIR = source
9-
BUILDDIR = build
5+
SPHINXOPTS ?=
6+
SPHINXBUILD ?= .venv/bin/sphinx-build
7+
SPHINXAUTOBUILD ?= .venv/bin/sphinx-autobuild
8+
PIP ?= .venv/bin/pip
9+
PYTHON ?= .venv/bin/python
10+
SOURCEDIR = source
11+
BUILDDIR = build
1012

1113
# Put it first so that "make" without argument is like "make help".
1214
help:
1315
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1416

15-
.PHONY: help Makefile
17+
.PHONY: help Makefile setup dev
18+
19+
# Setup virtual environment and install dependencies
20+
setup:
21+
python -m venv .venv && \
22+
. .venv/bin/activate && \
23+
.venv/bin/pip install --upgrade pip && \
24+
.venv/bin/pip install -r requirements.txt
25+
26+
# Run sphinx-autobuild for live-reloading docs during development
27+
dev:
28+
@$(SPHINXAUTOBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
1629

1730
# Catch-all target: route all unknown targets to Sphinx using the new
1831
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1932
%: Makefile
20-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
33+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Docs/make.bat

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

Docs/requirements.txt

-40 Bytes
Binary file not shown.

Docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747

4848
html_context = {
4949
"display_github": True,
50-
"github_user": "Robotics-PEC",
51-
"github_repo": "Getting-Started-with-ROS",
50+
"github_user": "Witty-Wizard",
51+
"github_repo": "DriveMaster",
5252
"github_version": "main",
5353
"conf_py_path": "/Docs/source/", # Adjust based on repo structure
5454
}

0 commit comments

Comments
 (0)