Skip to content

Commit d5f40ca

Browse files
committed
Fix MkDocs build issues
- Remove broken links to non-existent files (troubleshooting.md, reference/) - Clean up mkdocs.yml configuration - Remove unused plugins and dependencies - Fix GitHub Actions workflow - Documentation now builds successfully in strict mode
1 parent 075a9bc commit d5f40ca

10 files changed

Lines changed: 1991 additions & 161 deletions

File tree

docs/DOCS_README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/README.md

Lines changed: 0 additions & 107 deletions
This file was deleted.

docs/gen_ref_pages.py

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/getting-started/installation.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,6 @@ esri-converter convert input.gdb output.parquet --chunk-size 10000
190190

191191
If you encounter issues:
192192

193-
1. Check the [troubleshooting guide](../user-guide/troubleshooting.md)
194193
2. Search [existing issues](https://github.com/mihiarc/esri-converter/issues)
195194
3. Create a [new issue](https://github.com/mihiarc/esri-converter/issues/new) with:
196195
- Your operating system and Python version

docs/getting-started/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Now that you've completed your first conversion, explore more advanced features:
185185
- **[Examples](examples.md)** - Common usage patterns and workflows
186186
- **[User Guide](../user-guide/converting.md)** - Detailed conversion options
187187
- **[Performance Tips](../user-guide/performance.md)** - Optimize for your use case
188-
- **[API Reference](../reference/)** - Complete API documentation
188+
- ****API Reference** - Complete function documentation (available in code docstrings)** - Complete API documentation
189189

190190
## Real-World Example
191191

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ graph TD
8181
- [**Installation Guide**](getting-started/installation.md) - Get up and running quickly
8282
- [**Quick Start Tutorial**](getting-started/quickstart.md) - Your first conversion in 5 minutes
8383
- [**User Guide**](user-guide/converting.md) - Complete conversion workflows
84-
- [**API Reference**](reference/) - Detailed API documentation
84+
- **API Reference** - Complete function documentation (available in code docstrings) - Detailed API documentation
8585
- [**Performance Tips**](user-guide/performance.md) - Optimize for your use case
8686

8787
## 🤝 Community & Support

mkdocs.yml

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,12 @@ repo_url: https://github.com/mihiarc/esri-converter
99
theme:
1010
name: material
1111
palette:
12-
# Palette toggle for light mode
1312
- scheme: default
1413
primary: blue
1514
accent: indigo
1615
toggle:
1716
icon: material/brightness-7
1817
name: Switch to dark mode
19-
# Palette toggle for dark mode
2018
- scheme: slate
2119
primary: blue
2220
accent: indigo
@@ -38,21 +36,6 @@ theme:
3836

3937
plugins:
4038
- search
41-
- gen-files:
42-
scripts:
43-
- docs/gen_ref_pages.py
44-
- literate-nav:
45-
nav_file: SUMMARY.md
46-
- section-index
47-
- mkdocstrings:
48-
handlers:
49-
python:
50-
options:
51-
docstring_style: google
52-
show_source: true
53-
show_root_heading: true
54-
show_symbol_type_heading: true
55-
show_symbol_type_toc: true
5639
- mermaid2
5740

5841
markdown_extensions:
@@ -90,7 +73,6 @@ nav:
9073
- Command Line Usage: user-guide/cli.md
9174
- Batch Processing: user-guide/batch.md
9275
- Performance Tips: user-guide/performance.md
93-
- API Reference: reference/
9476
- Development:
9577
- Contributing: development/contributing.md
9678
- Architecture: development/architecture.md
@@ -103,4 +85,4 @@ extra:
10385
link: https://github.com/mihiarc/esri-converter
10486

10587
extra_css:
106-
- stylesheets/extra.css
88+
- stylesheets/extra.css

mkdocs.yml.backup

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
site_name: ESRI Converter
2+
site_description: Modern Python package for converting ESRI Geodatabase files to GeoParquet format
3+
site_author: mihiarc
4+
site_url: https://mihiarc.github.io/esri-converter
5+
6+
repo_name: mihiarc/esri-converter
7+
repo_url: https://github.com/mihiarc/esri-converter
8+
9+
theme:
10+
name: material
11+
palette:
12+
# Palette toggle for light mode
13+
- scheme: default
14+
primary: blue
15+
accent: indigo
16+
toggle:
17+
icon: material/brightness-7
18+
name: Switch to dark mode
19+
# Palette toggle for dark mode
20+
- scheme: slate
21+
primary: blue
22+
accent: indigo
23+
toggle:
24+
icon: material/brightness-4
25+
name: Switch to light mode
26+
27+
features:
28+
- navigation.tabs
29+
- navigation.sections
30+
- navigation.expand
31+
- navigation.path
32+
- navigation.top
33+
- search.highlight
34+
- search.share
35+
- toc.follow
36+
- content.code.copy
37+
- content.code.annotate
38+
39+
plugins:
40+
- search
41+
show_symbol_type_heading: true
42+
show_symbol_type_toc: true
43+
- mermaid2
44+
45+
markdown_extensions:
46+
- pymdownx.highlight:
47+
anchor_linenums: true
48+
line_spans: __span
49+
pygments_lang_class: true
50+
- pymdownx.inlinehilite
51+
- pymdownx.snippets
52+
- pymdownx.superfences:
53+
custom_fences:
54+
- name: mermaid
55+
class: mermaid
56+
format: !!python/name:pymdownx.superfences.fence_code_format
57+
- pymdownx.tabbed:
58+
alternate_style: true
59+
- pymdownx.tasklist:
60+
custom_checkbox: true
61+
- admonition
62+
- pymdownx.details
63+
- attr_list
64+
- md_in_html
65+
- tables
66+
- toc:
67+
permalink: true
68+
69+
nav:
70+
- Home: index.md
71+
- Getting Started:
72+
- Installation: getting-started/installation.md
73+
- Quick Start: getting-started/quickstart.md
74+
- Examples: getting-started/examples.md
75+
- User Guide:
76+
- Converting GDB Files: user-guide/converting.md
77+
- Command Line Usage: user-guide/cli.md
78+
- Batch Processing: user-guide/batch.md
79+
- Performance Tips: user-guide/performance.md
80+
- API Reference: reference/
81+
- Development:
82+
- Contributing: development/contributing.md
83+
- Architecture: development/architecture.md
84+
- Testing: development/testing.md
85+
- Changelog: changelog.md
86+
87+
extra:
88+
social:
89+
- icon: fontawesome/brands/github
90+
link: https://github.com/mihiarc/esri-converter
91+
92+
extra_css:
93+
- stylesheets/extra.css

pyproject.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,3 +181,8 @@ dev = [
181181
"python-dotenv>=1.1.0",
182182
"twine>=6.1.0",
183183
]
184+
docs = [
185+
"mkdocs>=1.6.1",
186+
"mkdocs-material>=9.6.14",
187+
"mkdocs-mermaid2-plugin>=1.2.1",
188+
]

0 commit comments

Comments
 (0)