Skip to content

Commit

Permalink
Update Sphinx config for better doc rendering πŸ“š
Browse files Browse the repository at this point in the history
- Changed `source_suffix` to dictionary format for explicit mapping.
- Set documentation language to English in `conf.py`.
- Updated `intersphinx_mapping` for clearer reference links.

These adjustments improve the clarity and flexibility of the documentation setup, ensuring a more consistent and user-friendly experience.
  • Loading branch information
horta committed Oct 28, 2024
1 parent baf6874 commit 1f130b1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ def find_version(filepath):
templates_path = ["_templates"]
autosectionlabel_prefix_document = True

source_suffix = ".rst"
source_suffix = {".rst": "restructuredtext"}

master_doc = "index"
man_pages = [(master_doc, project, "{} documentation".format(project), [author], 1)]
language = None
language = "en"

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "conf.py"]

Expand All @@ -63,7 +63,7 @@ def find_version(filepath):
htmlhelp_basename = "{}doc".format(project)

intersphinx_mapping = {
"https://docs.python.org/": None,
"python": ("https://docs.python.org/3", None),
"numpy": ("https://docs.scipy.org/doc/numpy/", None),
"pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
}

0 comments on commit 1f130b1

Please sign in to comment.