Skip to content

Commit

Permalink
Merge pull request #514 from analogdevicesinc/tfcollins/pdf-doc
Browse files Browse the repository at this point in the history
Tfcollins/pdf doc
  • Loading branch information
tfcollins authored Jan 10, 2024
2 parents 4af6978 + fb1bd40 commit 0b72cff
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 6 deletions.
15 changes: 15 additions & 0 deletions doc/source/_static/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,18 @@ body>div>aside>div>div>div.sidebar-scroll>div>ul {
element.style {
display: none;
}

/* Animate page entries */
.article-container > article:nth-child(3) {
animation-duration: 0.2s;
animation-delay: 0s;
animation-name: fadeInBottom;
}

@keyframes fadeInBottom {
from {
opacity: 0;
transform: translateY(1%);
}
to { opacity: 1 }
}
9 changes: 6 additions & 3 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@
import sys
from typing import List

import sphinx_rtd_theme

sys.path.insert(0, os.path.abspath("../.."))
sys.setrecursionlimit(1500)

Expand Down Expand Up @@ -65,7 +63,6 @@
"sphinx.ext.autodoc",
"sphinx.ext.coverage",
"sphinx.ext.githubpages",
"sphinx_rtd_theme",
"myst_parser",
"sphinx_favicon",
"sphinxcontrib.mermaid",
Expand All @@ -84,6 +81,12 @@
coverage_ignore_classes = ["phy"]
coverage_ignore_modules = ["test.dma_tests", "test.generics"]

# -- Options for PDF output --------------------------------------------------
if os.path.exists(os.path.join("_themes", "pdf_theme")):
extensions.append("sphinx_simplepdf")
html_theme_path = ["_themes"]
simplepdf_theme = "pdf_theme"

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down
4 changes: 2 additions & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,12 @@ Sections
attr/index
guides/examples
guides/connectivity
devices/index
buffers/index
fpga/index
dev/index
libiio
support
dev/index
devices/index

Indices and tables
==================
Expand Down
2 changes: 1 addition & 1 deletion requirements_doc.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
sphinx>=2.0
sphinx-rtd-theme
myst-parser
furo
sphinx-favicon
sphinxcontrib-mermaid
sphinx-simplepdf
pillow

0 comments on commit 0b72cff

Please sign in to comment.