Skip to content

Commit 9baccac

Browse files
updated
1 parent 788d864 commit 9baccac

File tree

4 files changed

+74
-1
lines changed

4 files changed

+74
-1
lines changed

.gitignore

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,9 @@ Thumbs.db
4545

4646
# Generated output
4747
site/
48-
docs/
48+
docs/*
49+
!docs/conf.py
50+
!docs/_static/
51+
!docs/_static/custom.css
52+
!docs/_templates/
53+
!docs/_templates/.gitkeep

docs/_static/custom.css

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/* Custom styles for Python Bro Code docs */

docs/_templates/.gitkeep

Whitespace-only changes.

docs/conf.py

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
"""Sphinx configuration for Python Bro Code documentation."""
2+
3+
project = "Python Bro Code"
4+
copyright = "2024, Pavan Mudigonda"
5+
author = "Pavan Mudigonda"
6+
release = "1.0.0"
7+
8+
extensions = [
9+
"myst_parser",
10+
"sphinx.ext.autodoc",
11+
"sphinx.ext.viewcode",
12+
"sphinx_copybutton",
13+
"sphinx_design",
14+
]
15+
16+
myst_enable_extensions = [
17+
"colon_fence",
18+
"deflist",
19+
"fieldlist",
20+
"html_admonition",
21+
"html_image",
22+
"linkify",
23+
"replacements",
24+
"smartquotes",
25+
"strikethrough",
26+
"substitution",
27+
"tasklist",
28+
]
29+
myst_heading_anchors = 3
30+
31+
source_suffix = {
32+
".rst": "restructuredtext",
33+
".md": "markdown",
34+
}
35+
36+
templates_path = ["_templates"]
37+
exclude_patterns = [
38+
"_build",
39+
"Thumbs.db",
40+
".DS_Store",
41+
"**/.ipynb_checkpoints",
42+
"**/__pycache__",
43+
]
44+
45+
suppress_warnings = [
46+
"myst.header",
47+
"myst.xref_missing",
48+
]
49+
50+
html_theme = "furo"
51+
html_title = "Python Bro Code"
52+
html_static_path = ["_static"]
53+
html_css_files = ["custom.css"]
54+
55+
html_theme_options = {
56+
"light_css_variables": {
57+
"color-brand-primary": "#306998",
58+
"color-brand-content": "#306998",
59+
},
60+
"dark_css_variables": {
61+
"color-brand-primary": "#FFD43B",
62+
"color-brand-content": "#FFD43B",
63+
},
64+
"source_repository": "https://github.com/PavanMudigonda/python-bro-code",
65+
"source_branch": "main",
66+
"source_directory": "docs/",
67+
}

0 commit comments

Comments
 (0)