Skip to content

Commit 5f2a561

Browse files
authored
Feature/main fixing readme plus maintance (#48)
* Updating the README file with the correct information, updating the configuration file and adding a copy of the working version. * Forgot to add the README in the previous commit, here it is. * Fixed the problems with the quotes turning to double quotes created by my onSave formatter.
1 parent 0b16c9e commit 5f2a561

3 files changed

Lines changed: 11 additions & 3 deletions

File tree

README.MD

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,15 @@ The site hosts technical documentation for Ubiquity Robotics robots, covering ha
1414

1515
The documentation is built and deployed automatically using GitHub Actions. The latest version is available at:
1616

17-
<!-- TODO: Change this to the actual website when the repo is switched. -->
18-
**[https://paveljolak.github.io/learn2/](https://paveljolak.github.io/learn2/)**
17+
**[https://learn2.ubiquityrobotics.com/jazzy/](https://learn2.ubiquityrobotics.com/jazzy/)**
1918

2019
## Local Development
2120

2221
To build and run the documentation locally:
2322

2423
<!-- TODO: Add the right links and names for cloning the repository. -->
2524
```bash
26-
git clone https://github.com/Paveljolak/learn2.git
25+
git clone https://github.com/UbiquityRobotics/learn2.git
2726
cd learn2
2827
git fetch --all
2928
git branch -a

docs/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,13 @@
8484

8585
# project_name = project.replace(' ', '_')
8686

87+
# IMPORTANT:
88+
# ---------------------------------------------------------------------------------------------
89+
# This part gives error that language does not exists and set it to "None" in the local build process
90+
# DO NOT CHANGE IT: you will break the version management for the deployed documentation
8791
html_context['current_language'] = ''
8892
html_context['language'] = ''
93+
# ---------------------------------------------------------------------------------------------
8994

9095
# -- "Edit on GitHub" links --------------------------------------------------
9196
html_context['display_github'] = True

docs/conf.py.orig

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,14 @@ pygments_style = None
3636
html_theme = 'sphinx_rtd_theme'
3737
html_static_path = ['_static']
3838

39+
html_logo = "_static/logos/UbiquityRobotics_Logo_Full_White.png"
40+
3941
html_css_files = [
4042
'custom.css'
4143
]
4244

45+
html_js_files = ['custom.js']
46+
4347
# -- RTD lower-left menu setup -----------------------------------------------
4448
try:
4549
html_context

0 commit comments

Comments
 (0)