Skip to content

Handle inline math equations #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nasaul wants to merge 14 commits into
base: main
Choose a base branch
from
+23 −10
Open

Handle inline math equations #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
67414a4
Adds handler for backslashes for inline math
nasaul Dec 1, 2025
6cf45c0
Upgrades test for hierarchicalforecast
nasaul Dec 3, 2025
237fc4c
Adds TopDown test for hierarchicalforecast
nasaul Dec 3, 2025
de0adc4
Favors solution to a lambda function instead of defining new function.
nasaul Dec 3, 2025
6d51add
Removes f-string
nasaul Dec 3, 2025
a18946b
Updates testing for utilsforecast migration to narwhals and the cutof…
nasaul Dec 3, 2025
65dbd53
Updates installation to github
nasaul Dec 4, 2025
1948ad7
Updates datasetsforecast testing
nasaul Dec 4, 2025
9366b13
Adds regular installation of mlforecast
nasaul Dec 5, 2025
9685345
Updates solution to handle underscores
nasaul Dec 10, 2025
4f19761
Updates parser for undescore solve
nasaul Dec 10, 2025
32846ac
Updates TopDown test
nasaul Dec 10, 2025
031fef0
Updates griffe2md version
nasaul Dec 10, 2025
7c124a2
Merge branch 'main' into fix/math-handler
deven367 Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion mkdocstrings_parser/parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
# Suppress griffe warnings
logging.getLogger("griffe").setLevel(logging.ERROR)


class MkDocstringsParser:
def __init__(self):
pass
Expand Down Expand Up @@ -136,6 +135,18 @@ def generate_documentation(self, module_path: str, options: Dict[str, Any]) -> s
markdown_docs = render_object_docs(obj, config) # type: ignore

markdown_docs = markdown_docs.replace(f"### `{to_replace}.", "### `")
# Fix double backslashes in inline math equations
markdown_docs = re.sub(
r"\$([^$]+)\$",
lambda m: "$" + m.group(1).replace("\\\\", "\\") + "$",
markdown_docs
)
# Fix underscores in inline math equations
markdown_docs = re.sub(
r"\$([^$]+)\$",
lambda m: "$" + m.group(1).replace("\_", "_") + "$",
markdown_docs
)

return markdown_docs

Expand Down
18 changes: 10 additions & 8 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,18 @@ dependencies = [
dev = [
"pytest",
"pytest-cov",
"lightgbm<4.6"
]
nixtlaverse = [
"coreforecast",
"utilsforecast",
"datasetsforecast",
"mlforecast",
"hierarchicalforecast",
"neuralforecast",
"statsforecast",
"nixtla"
"coreforecast@git+https://github.com/Nixtla/coreforecast.git",
"utilsforecast@git+https://github.com/Nixtla/utilsforecast.git",
"datasetsforecast@git+https://github.com/Nixtla/datasetsforecast.git",
"mlforecast[dask]@git+https://github.com/Nixtla/mlforecast.git",
"mlforecast@git+https://github.com/Nixtla/mlforecast.git",
"hierarchicalforecast@git+https://github.com/Nixtla/hierarchicalforecast.git@fix/docs",
"neuralforecast@git+https://github.com/Nixtla/neuralforecast.git",
"statsforecast@git+https://github.com/Nixtla/statsforecast.git",
"nixtla@git+https://github.com/Nixtla/nixtla.git"
]
optional = ["pandas"]

Expand Down
2 changes: 1 addition & 1 deletion tests/test_hierarchicalforecast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,4 +240,4 @@ def test_bottomup(setup_parser):
---- | ---- | -----------
`y_tilde` | <code>[dict](#dict)</code> | Reconciliated y_hat using the Bottom Up approach.

"""
"""
Loading