|
| 1 | +import os |
| 2 | +import sys |
| 3 | + |
| 4 | +sys.path.insert(0, os.path.abspath("..")) |
| 5 | + |
| 6 | +project = "GeoLatent" |
| 7 | +author = "GeoLatent Contributors" |
| 8 | +copyright = "2026, GeoLatent Contributors" |
| 9 | +release = "0.1.0" |
| 10 | + |
| 11 | +extensions = [ |
| 12 | + "autoapi.extension", |
| 13 | + "sphinx.ext.napoleon", |
| 14 | + "sphinx.ext.viewcode", |
| 15 | + "sphinx.ext.intersphinx", |
| 16 | + "myst_parser", |
| 17 | + "sphinx_copybutton", |
| 18 | +] |
| 19 | + |
| 20 | +# Auto-generate API docs from source |
| 21 | +autoapi_dirs = ["../geolatent"] |
| 22 | +autoapi_type = "python" |
| 23 | +autoapi_options = [ |
| 24 | + "members", |
| 25 | + "undoc-members", |
| 26 | + "show-inheritance", |
| 27 | + "show-module-summary", |
| 28 | + "imported-members", |
| 29 | +] |
| 30 | +autoapi_keep_files = False |
| 31 | +autoapi_add_toctree_entry = True |
| 32 | +autoapi_python_class_content = "both" |
| 33 | + |
| 34 | +# Napoleon — numpy-style docstrings |
| 35 | +napoleon_google_docstring = False |
| 36 | +napoleon_numpy_docstring = True |
| 37 | +napoleon_use_param = True |
| 38 | +napoleon_use_rtype = True |
| 39 | + |
| 40 | +# Cross-package links |
| 41 | +intersphinx_mapping = { |
| 42 | + "python": ("https://docs.python.org/3", None), |
| 43 | + "numpy": ("https://numpy.org/doc/stable", None), |
| 44 | + "sklearn": ("https://scikit-learn.org/stable", None), |
| 45 | + "plotly": ("https://plotly.com/python-api-reference", None), |
| 46 | +} |
| 47 | + |
| 48 | +# MyST |
| 49 | +myst_enable_extensions = ["colon_fence", "deflist"] |
| 50 | +source_suffix = {".rst": "restructuredtext", ".md": "markdown"} |
| 51 | + |
| 52 | +html_theme = "pydata_sphinx_theme" |
| 53 | +html_title = "GeoLatent" |
| 54 | + |
| 55 | +html_theme_options = { |
| 56 | + "logo": { |
| 57 | + "text": "GeoLatent", |
| 58 | + }, |
| 59 | + "github_url": "https://github.com/FirePheonix/geolatent", |
| 60 | + "navbar_end": ["navbar-icon-links", "theme-switcher"], |
| 61 | + "secondary_sidebar_items": ["page-toc", "edit-this-page"], |
| 62 | + "footer_start": ["copyright"], |
| 63 | + "footer_end": ["sphinx-version"], |
| 64 | + "pygments_light_style": "friendly", |
| 65 | + "pygments_dark_style": "monokai", |
| 66 | + "navigation_with_keys": True, |
| 67 | + "show_toc_level": 2, |
| 68 | + "icon_links": [ |
| 69 | + { |
| 70 | + "name": "GitHub", |
| 71 | + "url": "https://github.com/FirePheonix/geolatent", |
| 72 | + "icon": "fa-brands fa-github", |
| 73 | + }, |
| 74 | + { |
| 75 | + "name": "PyPI", |
| 76 | + "url": "https://pypi.org/project/geolatent/", |
| 77 | + "icon": "fa-brands fa-python", |
| 78 | + }, |
| 79 | + ], |
| 80 | +} |
| 81 | + |
| 82 | +html_static_path = ["_static"] |
| 83 | +html_css_files = ["custom.css"] |
| 84 | +html_show_sourcelink = False |
| 85 | + |
| 86 | +templates_path = ["_templates"] |
| 87 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
0 commit comments