Skip to content

Commit

Permalink
Fix issue with relative doc paths.
Browse files Browse the repository at this point in the history
  • Loading branch information
flip-dots committed May 5, 2024
1 parent 2207951 commit 0ccd883
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
SOURCEDIR = source
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
Expand Down
2 changes: 1 addition & 1 deletion docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set SOURCEDIR=source
set BUILDDIR=_build

%SPHINXBUILD% >NUL 2>NUL
Expand Down
4 changes: 2 additions & 2 deletions docs/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Basic Example
Simple blinky light example demonstrating making a connection to a light
from its MAC address and making it turn off then on again.

.. literalinclude:: ../examples/example.py
.. literalinclude:: ../../examples/example.py
:language: python
:linenos:

Expand All @@ -33,6 +33,6 @@ the module using a push based approach.
- 🌈 XY Colour
- ✔️ Notifications of state changes to the light via push approach

.. literalinclude:: ../examples/demo.py
.. literalinclude:: ../../examples/demo.py
:language: python
:linenos:
2 changes: 1 addition & 1 deletion docs/source/history.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
.. include:: ../CHANGELOG.rst
.. include:: ../../CHANGELOG.rst
3 changes: 2 additions & 1 deletion docs/source/source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
Source
======

`GitHub<https://github.com/flip-dots/HueBLE>`_.
`GitHub
<https://github.com/flip-dots/hueble>`_.

0 comments on commit 0ccd883

Please sign in to comment.