Skip to content

Commit 517990a

Browse files
author
andrewluiqut
committed
initial commit
0 parents  commit 517990a

39 files changed

+1999
-0
lines changed

‎.github/workflows/sphinx.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: sphinx
2+
on: [push, pull_request, workflow_dispatch]
3+
4+
permissions:
5+
contents: write
6+
pages: write
7+
id-token: write
8+
9+
jobs:
10+
docs:
11+
environment:
12+
name: github-pages
13+
url: ${{ steps.deployment.outputs.page_url }}
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v3
17+
- uses: actions/setup-python@v3
18+
- name: Install dependencies
19+
run: |
20+
pip install sphinx sphinx_rtd_theme myst_parser docutils==0.20
21+
- name: Sphinx build
22+
run: |
23+
cd docs && sphinx-build source build/html
24+
- name: Upload artifact
25+
uses: actions/upload-pages-artifact@v3
26+
with:
27+
path: docs/build/html
28+
- name: Deploy to GitHub Pages
29+
id: deployment
30+
uses: actions/deploy-pages@v4

‎.gitignore

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
2+
# Project
3+
.vscode/*
4+
*.dot
5+
*.svg
6+
7+
# Byte-compiled / optimized / DLL files
8+
__pycache__/
9+
*.py[cod]
10+
*$py.class
11+
12+
# C extensions
13+
*.so
14+
15+
# Distribution / packaging
16+
.Python
17+
build/
18+
develop-eggs/
19+
dist/
20+
downloads/
21+
eggs/
22+
.eggs/
23+
lib/
24+
lib64/
25+
parts/
26+
sdist/
27+
var/
28+
wheels/
29+
share/python-wheels/
30+
*.egg-info/
31+
.installed.cfg
32+
*.egg
33+
MANIFEST
34+
35+
# PyInstaller
36+
# Usually these files are written by a python script from a template
37+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
38+
*.manifest
39+
*.spec
40+
41+
# Installer logs
42+
pip-log.txt
43+
pip-delete-this-directory.txt
44+
45+
# Unit test / coverage reports
46+
htmlcov/
47+
.tox/
48+
.nox/
49+
.coverage
50+
.coverage.*
51+
.cache
52+
nosetests.xml
53+
coverage.xml
54+
*.cover
55+
*.py,cover
56+
.hypothesis/
57+
.pytest_cache/
58+
cover/
59+
60+
# Translations
61+
*.mo
62+
*.pot
63+
64+
# Django stuff:
65+
*.log
66+
local_settings.py
67+
db.sqlite3
68+
db.sqlite3-journal
69+
70+
# Flask stuff:
71+
instance/
72+
.webassets-cache
73+
74+
# Scrapy stuff:
75+
.scrapy
76+
77+
# Sphinx documentation
78+
docs/_build/
79+
80+
# PyBuilder
81+
.pybuilder/
82+
target/
83+
84+
# Jupyter Notebook
85+
.ipynb_checkpoints
86+
87+
# IPython
88+
profile_default/
89+
ipython_config.py
90+
91+
# pyenv
92+
# For a library or package, you might want to ignore these files since the code is
93+
# intended to run in multiple environments; otherwise, check them in:
94+
# .python-version
95+
96+
# pipenv
97+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
98+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
99+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
100+
# install all needed dependencies.
101+
#Pipfile.lock
102+
103+
# poetry
104+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105+
# This is especially recommended for binary packages to ensure reproducibility, and is more
106+
# commonly ignored for libraries.
107+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108+
#poetry.lock
109+
110+
# pdm
111+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
112+
#pdm.lock
113+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
114+
# in version control.
115+
# https://pdm.fming.dev/#use-with-ide
116+
.pdm.toml
117+
118+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
119+
__pypackages__/
120+
121+
# Celery stuff
122+
celerybeat-schedule
123+
celerybeat.pid
124+
125+
# SageMath parsed files
126+
*.sage.py
127+
128+
# Environments
129+
.env
130+
.venv
131+
env/
132+
venv/
133+
ENV/
134+
env.bak/
135+
venv.bak/
136+
137+
# Spyder project settings
138+
.spyderproject
139+
.spyproject
140+
141+
# Rope project settings
142+
.ropeproject
143+
144+
# mkdocs documentation
145+
/site
146+
147+
# mypy
148+
.mypy_cache/
149+
.dmypy.json
150+
dmypy.json
151+
152+
# Pyre type checker
153+
.pyre/
154+
155+
# pytype static type analyzer
156+
.pytype/
157+
158+
# Cython debug symbols
159+
cython_debug/
160+

‎README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Web Publishing of Documentation for a Github Repository
2+
3+
**Robotics and Autonomous Systems Group, Research Engineering Facility, Research Infrastructure**
4+
**Queensland University of Technology**
5+
6+
This repository is an example of a building a documentation website for a Github repository as well as a template for adapting to other projects. The documentation website is hosted on Github Pages so that source code management, documentation, and web publishing can be managed on a single platform.
7+
8+
Plesse refer to the [Tutorial](./docs/source/README.md) page on how to setup such a website easily.
9+
10+
11+
### Author
12+
13+
Dr Andrew Lui, Senior Research Engineer <br />
14+
Robotics and Autonomous Systems, Research Engineering Facility <br />
15+
Research Infrastructure <br />
16+
Queensland University of Technology <br />
17+
18+
Latest update: April 2024

‎docs/Makefile

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SOURCEDIR = source
8+
BUILDDIR = build
9+
10+
# Put it first so that "make" without argument is like "make help".
11+
help:
12+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
13+
14+
.PHONY: help Makefile
15+
16+
# Catch-all target: route all unknown targets to Sphinx using the new
17+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
18+
%: Makefile
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
33+
34+
:end
35+
popd

‎docs/source/PAGE_1.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Title of Page 1
2+
3+
## Overview of Page 1
4+
5+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
6+
7+
![Placeholder](./_static/assets/Placeholder1.jpg)
8+
9+
## Backoground
10+
11+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Et ultrices neque ornare aenean euismod elementum. Imperdiet dui accumsan sit amet nulla facilisi. Mi ipsum faucibus vitae aliquet nec. Lorem sed risus ultricies tristique nulla aliquet. Purus semper eget duis at tellus at urna condimentum mattis. Neque viverra justo nec ultrices dui sapien. Leo in vitae turpis massa sed elementum tempus egestas. Sed libero enim sed faucibus turpis in eu mi bibendum. Nunc vel risus commodo viverra maecenas accumsan. Sed felis eget velit aliquet sagittis id consectetur purus. Viverra orci sagittis eu volutpat. Egestas maecenas pharetra convallis posuere. Felis eget velit aliquet sagittis id consectetur purus.
12+
13+
### Problem Analysis
14+
15+
Gravida quis blandit turpis cursus in hac habitasse. Est sit amet facilisis magna etiam tempor. Urna condimentum mattis pellentesque id nibh tortor. Arcu dui vivamus arcu felis bibendum ut tristique et. Consequat interdum varius sit amet. Placerat in egestas erat imperdiet. In nulla posuere sollicitudin aliquam ultrices sagittis orci a. Nisl vel pretium lectus quam id leo in. A cras semper auctor neque vitae tempus quam pellentesque nec. Leo vel orci porta non pulvinar neque. Sit amet est placerat in egestas erat. Ut diam quam nulla porttitor. Egestas sed tempus urna et pharetra pharetra massa massa. Tristique risus nec feugiat in fermentum posuere urna nec tincidunt. Sed velit dignissim sodales ut eu sem integer vitae justo. Libero volutpat sed cras ornare. Quis risus sed vulputate odio ut enim blandit. Et malesuada fames ac turpis egestas integer eget aliquet. Donec et odio pellentesque diam volutpat. Tellus rutrum tellus pellentesque eu tincidunt tortor aliquam nulla facilisi.
16+
17+
### Existing Solutions
18+
19+
Pellentesque habitant morbi tristique senectus et netus et. Mi tempus imperdiet nulla malesuada pellentesque elit eget gravida cum. Amet venenatis urna cursus eget. Integer malesuada nunc vel risus commodo viverra maecenas. Tellus cras adipiscing enim eu turpis egestas pretium. Et magnis dis parturient montes nascetur. Accumsan tortor posuere ac ut consequat. Vulputate mi sit amet mauris commodo. Nunc faucibus a pellentesque sit amet porttitor eget dolor morbi. Dictum sit amet justo donec enim. Vel fringilla est ullamcorper eget nulla. Aliquam sem et tortor consequat id porta nibh. Malesuada fames ac turpis egestas sed tempus urna et. Viverra aliquet eget sit amet tellus cras adipiscing enim eu. Enim neque volutpat ac tincidunt vitae semper.
20+
21+
![Placeholder](./_static/assets/Placeholder2.jpg)
22+
23+
### Relevant Technologies
24+
25+
In egestas erat imperdiet sed euismod nisi. At augue eget arcu dictum varius duis at. Malesuada fames ac turpis egestas. Convallis posuere morbi leo urna molestie at elementum eu facilisis. A arcu cursus vitae congue mauris rhoncus aenean vel. Orci phasellus egestas tellus rutrum tellus pellentesque eu tincidunt. Vitae purus faucibus ornare suspendisse sed nisi lacus sed. Commodo viverra maecenas accumsan lacus vel. At quis risus sed vulputate odio ut enim. Iaculis at erat pellentesque adipiscing commodo elit at imperdiet. Neque convallis a cras semper auctor neque vitae. In ante metus dictum at tempor commodo ullamcorper. Integer quis auctor elit sed vulputate mi sit. At imperdiet dui accumsan sit amet nulla facilisi. Lectus mauris ultrices eros in.
26+
27+
### Summary of Findings
28+
29+
Semper quis lectus nulla at volutpat diam ut venenatis. Morbi tincidunt augue interdum velit euismod. Felis donec et odio pellentesque diam volutpat commodo sed. Turpis nunc eget lorem dolor sed viverra ipsum nunc. At tellus at urna condimentum. Eget sit amet tellus cras adipiscing enim eu turpis. Amet venenatis urna cursus eget nunc. Adipiscing tristique risus nec feugiat in fermentum. Faucibus turpis in eu mi bibendum neque egestas congue. Massa vitae tortor condimentum lacinia quis vel.
30+
31+
## Method
32+
33+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
34+
35+
### Top-level Architecture
36+
37+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Nibh nisl condimentum id venenatis a condimentum vitae sapien. Diam volutpat commodo sed egestas egestas fringilla phasellus faucibus scelerisque. Ut venenatis tellus in metus vulputate. Purus semper eget duis at. Dolor purus non enim praesent. Posuere sollicitudin aliquam ultrices sagittis orci a scelerisque purus semper. Facilisis leo vel fringilla est ullamcorper eget nulla facilisi etiam. Nisl purus in mollis nunc sed. Mattis ullamcorper velit sed ullamcorper morbi tincidunt ornare. Elit ut aliquam purus sit amet luctus. Sed lectus vestibulum mattis ullamcorper velit sed ullamcorper. Nullam eget felis eget nunc lobortis mattis aliquam. Nec ullamcorper sit amet risus nullam eget felis eget nunc. Egestas tellus rutrum tellus pellentesque eu tincidunt.
38+
39+
### Details of the Major Components
40+
41+
Nisl suscipit adipiscing bibendum est ultricies integer. Viverra adipiscing at in tellus. Aliquet nec ullamcorper sit amet risus nullam. A diam sollicitudin tempor id eu. Et ultrices neque ornare aenean euismod elementum nisi quis eleifend. Vel pretium lectus quam id leo in vitae turpis massa. In hendrerit gravida rutrum quisque non tellus orci ac. Ipsum dolor sit amet consectetur adipiscing elit ut aliquam purus. Sed egestas egestas fringilla phasellus faucibus scelerisque eleifend. Sapien eget mi proin sed libero enim sed faucibus. Etiam dignissim diam quis enim lobortis. Enim praesent elementum facilisis leo vel. Dolor morbi non arcu risus quis varius quam. In mollis nunc sed id semper risus in hendrerit gravida. Scelerisque viverra mauris in aliquam. Venenatis a condimentum vitae sapien pellentesque habitant morbi. Adipiscing commodo elit at imperdiet dui accumsan. Iaculis at erat pellentesque adipiscing commodo elit at imperdiet. Egestas quis ipsum suspendisse ultrices gravida dictum fusce ut placerat.
42+
43+
#### Component 1
44+
45+
Congue mauris rhoncus aenean vel elit scelerisque mauris pellentesque. Quam vulputate dignissim suspendisse in est. Suscipit tellus mauris a diam maecenas sed enim. Dapibus ultrices in iaculis nunc sed. Vitae nunc sed velit dignissim sodales ut eu sem. Neque egestas congue quisque egestas. Est ultricies integer quis auctor elit. Aliquam sem et tortor consequat id porta. Imperdiet dui accumsan sit amet nulla facilisi morbi. Ultrices in iaculis nunc sed augue lacus. Semper auctor neque vitae tempus quam pellentesque nec nam aliquam. Sapien et ligula ullamcorper malesuada proin libero nunc.
46+
47+
#### Component 2
48+
49+
Tellus mauris a diam maecenas sed enim ut. A lacus vestibulum sed arcu. Risus viverra adipiscing at in. Laoreet suspendisse interdum consectetur libero id faucibus. Vitae et leo duis ut diam quam nulla. Sed pulvinar proin gravida hendrerit lectus. Euismod quis viverra nibh cras pulvinar mattis. Viverra tellus in hac habitasse platea dictumst vestibulum. Neque viverra justo nec ultrices dui sapien eget mi proin. Nulla facilisi morbi tempus iaculis urna id volutpat lacus laoreet. Faucibus ornare suspendisse sed nisi. Mattis enim ut tellus elementum sagittis vitae et. Est ultricies integer quis auctor elit sed.
50+
### Implementation Plan
51+
Eget gravida cum sociis natoque penatibus et magnis. Auctor eu augue ut lectus arcu bibendum. Vestibulum lorem sed risus ultricies tristique. Maecenas volutpat blandit aliquam etiam erat velit scelerisque. Gravida dictum fusce ut placerat orci nulla pellentesque. Varius quam quisque id diam vel. Cursus vitae congue mauris rhoncus aenean vel elit. Fringilla est ullamcorper eget nulla facilisi etiam. Vel risus commodo viverra maecenas. Mi ipsum faucibus vitae aliquet nec ullamcorper sit amet risus. Hac habitasse platea dictumst vestibulum. Turpis cursus in hac habitasse platea dictumst quisque sagittis.
52+
53+
## Prototype Implementation and Testing
54+
55+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
56+
57+
## Conclusion
58+
59+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

‎docs/source/PAGE_2.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Title of Page 2
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
4+
5+
## Overview of Page 2
6+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
7+
8+
![Placeholder](./_static/assets/Placeholder3.jpg)
9+
10+
## Backoground
11+
12+
### Problem Analysis
13+
14+
### Relevant Technologies
15+
16+
### Techical Gaps
17+
18+
### Summary of Findings
19+
20+
21+
## Method
22+
23+
### Data Collection
24+
25+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
26+
27+
![Placeholder](./_static/assets/Placeholder4.jpg)
28+
29+
### Model Training Scheme
30+
31+
### Details of Key Algorithms
32+
33+
#### Algorithm 1
34+
35+
#### Algorithm 2
36+
37+
#### Algorithm 3
38+
39+
40+
## Model Training and Testing
41+
42+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
43+
44+
## Conclusion
45+
46+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

0 commit comments

Comments
 (0)