Skip to content

Commit

Permalink
Merge branch 'gurka-better-docs' into 'devel'
Browse files Browse the repository at this point in the history
DOC [STYLE]: Change theme to clearer and more readable one

See merge request ndk/ndk-fpga!91
  • Loading branch information
jakubcabal committed Oct 25, 2024
2 parents ea2302f + cdcdbf9 commit cf4d634
Show file tree
Hide file tree
Showing 6 changed files with 301 additions and 121 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- name: Setup and build
run: |
sudo apt-get install python3-pip
pip3 install sphinx sphinx-vhdl sphinx_rtd_theme piccolo_theme GitPython
pip3 install sphinx sphinx-vhdl sphinx_rtd_theme furo GitPython
mkdir public
mkdir public/html
cp doc/source/index.html public/html/
Expand Down
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ pages:
- apk add git
- pip install -U GitPython
- pip install -U sphinx
- pip install -U piccolo_theme
- pip install -U furo
- pip install -U sphinx-vhdl
- echo "Hotfix detached head, causing trouble in GitPython:"
- git checkout $CI_COMMIT_BRANCH
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ First, you need to install a few Python packages:
$ pip3 install --user GitPython
$ pip3 install --user sphinx
$ pip3 install --user sphinx-vhdl
$ pip3 install --user piccolo_theme
$ pip3 install --user furo
```

Then the documentation is generated simply by issuing these two commands:
Expand Down
115 changes: 0 additions & 115 deletions doc/source/_templates/layout.html

This file was deleted.

Loading

0 comments on commit cf4d634

Please sign in to comment.