Skip to content

Commit

Permalink
docs: Use adi-doctools
Browse files Browse the repository at this point in the history
1. Add extension and theme in conf.py
2. Add doc build products to gitignore
3. Add requirements file

Signed-off-by: RibhuDP <[email protected]>
  • Loading branch information
ribdp committed Apr 10, 2024
1 parent bee62a7 commit f872b9d
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
5 changes: 1 addition & 4 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@ jobs:

- name: Install dependencies
run: |
sudo apt install -y python3-numpy
pip install -r requirements_doc.txt
python -m pip install sphinx-toolbox
pip install sphinx myst_parser
pip install -r docs/source/requirements_doc.txt
sudo apt-get install doxygen graphviz -y
- name: Check doc build
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.github/CODEOWNERS
.github/CODEOWNERS
docs/build/
15 changes: 7 additions & 8 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'Precision Toolbox for MATLAB'
copyright = '2023, Analog Devices Inc.'
author = 'Analog Devices Inc.'
repository = 'PrecisionToolbox'
project = 'Precision Toolbox'
copyright = '2023-2024, Analog Devices Inc.'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand All @@ -28,18 +28,17 @@


extensions = [
'sphinx_toolbox.collapse'
'adi_doctools'
]

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']



# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "bizstyle"
html_static_path = ['_static']
html_theme = "cosmic"
html_static_path = []

html_logo = "adi_logo.png"
#html_logo = "adi_logo.png"
3 changes: 3 additions & 0 deletions docs/source/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
sphinx
myst_parser
https://github.com/analogdevicesinc/doctools/releases/download/latest/adi-doctools.tar.gz

0 comments on commit f872b9d

Please sign in to comment.