Skip to content

Commit 792ffe9

Browse files
Fix documentation configuration and dependencies
1 parent 4970958 commit 792ffe9

File tree

3 files changed

+20
-2
lines changed

3 files changed

+20
-2
lines changed

.gitignore

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,12 @@ dmypy.json
107107

108108
# OS system files
109109
.DS_Store
110-
**/.DS_Store
110+
**/.DS_Store
111+
.vscode/
112+
.idea/
113+
*.suo
114+
*.ntvs*
115+
*.njsproj
116+
*.sln
117+
*.sw?
118+
*.user

docs/conf.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212

1313
# Extensions needed for markdown support
1414
extensions = [
15+
'sphinx_markdown_tables', # Markdown tables
1516
'myst_parser', # Markdown support
1617
'sphinx.ext.autodoc', # API documentation
1718
'sphinx.ext.viewcode', # View source code
1819
'sphinx.ext.napoleon', # Google style docstrings
19-
'sphinx_markdown_tables', # Markdown tables
2020
'sphinx_copybutton', # Copy button for code blocks
2121
'sphinx_design', # UI components
2222
]
@@ -60,4 +60,12 @@
6060
'sidebar/navigation.html',
6161
'sidebar/scroll-end.html',
6262
]
63+
}
64+
65+
# GitHub integration
66+
html_context = {
67+
'display_github': True,
68+
'github_user': 'muditbhargava66',
69+
'github_repo': 'serdes-validation-framework',
70+
'github_version': 'main/docs/',
6371
}

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
myst-parser[linkify]>=1.2.0
2+
linkify-it-py>=2.0.3
13
sphinx>=4.0.0
24
sphinx-rtd-theme>=1.0.0
35
myst-parser>=0.18.1

0 commit comments

Comments
 (0)