Skip to content

Commit 6c810e2

Browse files
Update requirements.txt for Sphinx and extensions
1 parent 6b4e378 commit 6c810e2

File tree

5 files changed

+10
-18
lines changed

5 files changed

+10
-18
lines changed

docs/api_documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Advanced Image Sensor Interface: API Documentation
1+
# API Documentation
22

33
## 1. Introduction
44

docs/conf.py

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,10 @@
66

77
# -- Path setup --------------------------------------------------------------
88

9-
# If extensions (or modules to document with autodoc) are in another directory,
10-
# add these directories to sys.path here. If the directory is relative to the
11-
# documentation root, use os.path.abspath to make it absolute, like shown here.
12-
#
139
import os
1410
import sys
1511
sys.path.insert(0, os.path.abspath('../src'))
1612

17-
1813
# -- Project information -----------------------------------------------------
1914

2015
project = 'Advanced Image Sensor Interface'
@@ -24,12 +19,9 @@
2419
# The full version, including alpha/beta/rc tags
2520
release = 'v1.0.0'
2621

27-
2822
# -- General configuration ---------------------------------------------------
2923

30-
# Add any Sphinx extension module names here, as strings. They can be
31-
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32-
# ones.
24+
# Add any Sphinx extension module names here, as strings.
3325
extensions = [
3426
'sphinx.ext.autodoc',
3527
'sphinx.ext.napoleon',
@@ -43,16 +35,16 @@
4335

4436
# List of patterns, relative to source directory, that match files and
4537
# directories to ignore when looking for source files.
46-
# This pattern also affects html_static_path and html_extra_path.
4738
exclude_patterns = []
4839

40+
# The master toctree document.
41+
master_doc = 'index'
4942

5043
# -- Options for HTML output -------------------------------------------------
5144

5245
# The theme to use for HTML and HTML Help pages. See the documentation for
5346
# a list of builtin themes.
54-
#
55-
html_theme = 'alabaster'
47+
html_theme = "sphinx_rtd_theme"
5648

5749
# Add any paths that contain custom static files (such as style sheets) here,
5850
# relative to this directory. They are copied after the builtin static files,
@@ -63,4 +55,4 @@
6355
source_suffix = {
6456
'.rst': 'restructuredtext',
6557
'.md': 'markdown',
66-
}
58+
}

docs/design_specs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Advanced Image Sensor Interface: Design Specifications
1+
# Design Specifications
22

33
## 1. Introduction
44

docs/performance_analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Advanced Image Sensor Interface: Performance Analysis
1+
# Performance Analysis
22

33
## 1. Introduction
44

docs/requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
sphinx>=5.0
2-
sphinxcontrib-applehelp
32
sphinx_rtd_theme
4-
myst-parser
3+
myst-parser
4+
sphinxcontrib-applehelp

0 commit comments

Comments
 (0)