Skip to content

Documentation enhancement to highlight code blocks #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kayjan merged 5 commits into from
Nov 23, 2023
Merged

Documentation enhancement to highlight code blocks #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2d1fff4
Added: Highlight lines in markdown file
kayjan Nov 18, 2023
ba05a35
Added: Highlight lines in markdown file
kayjan Nov 18, 2023
b12fffb
Added: Documentation to have highlight text
kayjan Nov 23, 2023
e00af67
Added: Add more emoji to documentation
kayjan Nov 23, 2023
d77a9d4
Added: Documentation to have highlight text
kayjan Nov 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 99 additions & 51 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
autodocsumm==0.2.9
autodocsumm==0.2.11
karma-sphinx-theme==0.0.8
myst-parser==0.18.1
myst-parser~=1.0.0
pandas==1.5.1
sphinxemoji==0.2.0
14 changes: 11 additions & 3 deletions docs/source/_static/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/* Palette
#1D4289 Blue
#212322 Black
#D7A068 Gold (Replace #CEB47E Sand)
#D7A068 Gold (rgb 215,160,104)(Replace #CEB47E Sand)
#DBE2E9 Light blue
#B7926C Dark sand
*/
Expand All @@ -21,11 +21,15 @@ header {
h1, h2, h3, h4, p, a {
font-family: Nobile, sans-serif !important;
}
p {
margin-bottom: 2rem;
}
a {
color: #D7A068 !important;
}
blockquote {
border-left: 5px solid grey;
border-left: 2px solid grey;
padding: 0.5rem 1.5rem;
}
blockquote p {
display: inline;
Expand Down Expand Up @@ -55,11 +59,15 @@ span.pre {

/* Code box */
.highlight pre {
background: lightyellow !important;
background: lightyellow;
}
.highlight .c1 {
font-style: normal;
}
.hll {
display: block;
background-color: rgba(215,160,104,0.2) !important;
}

/* Table */
table {
Expand Down
2 changes: 1 addition & 1 deletion docs/source/binarytree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Binary Tree
|:cactus:| Binary Tree
===================================

.. toctree::
Expand Down
3 changes: 3 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@
]
autodoc_default_options = {"autosummary": True}
sphinxemoji_style = "twemoji"
myst_enable_extensions = [
"attrs_block",
]

templates_path = ["_templates"]
exclude_patterns = []
Expand Down
4 changes: 2 additions & 2 deletions docs/source/dag.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Directed Acyclic Graph (DAG)
===================================
|:palm_tree:| Directed Acyclic Graph (DAG)
==========================================

.. toctree::
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
:alt: black

.. toctree::
:maxdepth: 2
:maxdepth: 1

node
binarytree
Expand Down
2 changes: 1 addition & 1 deletion docs/source/node.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Node
|:herb:| Node
===================================

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion docs/source/others.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Others
|:globe_with_meridians:| Others
===================================

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Tree
|:evergreen_tree:| Tree
===================================

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion docs/source/utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Utils
|:wrench:| Utils
===================================

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion docs/source/workflows.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Workflows
|:construction_worker:| Workflows
===================================

.. toctree::
Expand Down