Skip to content

Commit 2045121

Browse files
authored
🎨 Update docs theme and add tutorial (#1184)
- Update the theme to furo and style colors to match new branding - branding coloring loosely based on https://mintlify.com/docs/quickstart - Restructure toc-trees, to make the documentation easier to navigate - Improve landing page - Improve top "hero" section - Add feature section - move examples to tutorial - Add tutorial page, with worked example covering most directives - took some things from https://sphinx-needs-demo.readthedocs.io
1 parent 1de1a7a commit 2045121

File tree

93 files changed

+2577
-1425
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+2577
-1425
lines changed

β€Ž.gitignore

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,6 @@ coverage.xml
2323
.doctrees
2424
docs/github_images/
2525
.eggs/
26-
docs/_images/need_pie_*.*
27-
28-
docs/_images/need_bar_*.*
2926

3027

3128
.devcontainer/
@@ -36,8 +33,6 @@ docs/_images/need_bar_*.*
3633
tests/cypress/
3734
cypress/
3835

39-
need_bar_*.png
40-
need_pie_*.png
4136
output.json
4237
mem_out.*
4338

β€Ž.readthedocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ python:
1111
path: .
1212
extra_requirements:
1313
- docs
14-
- theme-im
14+
- theme-furo
1515

1616
build:
1717
os: ubuntu-22.04
@@ -27,4 +27,4 @@ build:
2727
pre_build:
2828
# ideally we would just set the DOCS_THEME environment variable
2929
# but I couldn't see an easy way to do that for the build job
30-
- 'echo "sphinx_immaterial" > docs/DOCS_THEME'
30+
- 'echo "furo" > docs/DOCS_THEME'

β€Ždocker/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# syntax = docker/dockerfile:1.2
33
ARG BASE_IMAGE=sphinxdoc/sphinx:latest
44
FROM $BASE_IMAGE
5-
LABEL maintainer="Useblocks <https://useblocks.com/>"
5+
LABEL maintainer="useblocks <https://useblocks.com/>"
66

77
ARG DOCKER_USERNAME=dockeruser
88
ARG DOCKER_USER_ID=1000
File renamed without changes.

β€Ždocs/_images/car.png

1.18 MB
Loading
File renamed without changes.

0 commit comments

Comments
Β (0)