[docs] lazydocs to mkdocstrings #405
Conversation
|
@elephaint This PR is ready, but I can't figure the latex rendering issue from the docstrings, everything else looks good! |
| api_docs: | ||
| lazydocs .hierarchicalforecast --no-watermark | ||
| python docs/to_mdx.py | ||
| # lazydocs .hierarchicalforecast --no-watermark |
| - name: Install dependencies | ||
| run: | | ||
| pip install -e . lazydocs pyyaml | ||
| pip install -e . griffe2md pyyaml |
There was a problem hiding this comment.
Any reason not to use uv here?
There was a problem hiding this comment.
Mainly because our open-source repos don’t use uv, and I wanted to keep the workflow consistent with the rest of the Nixtlaverse.
happy to switch to uv if we want to standardize
|
|
||
| clean: | ||
| rm -f docs/*.md | ||
| # rm -f docs/*.md |
| import yaml | ||
| from griffe2md import ConfigDict, render_object_docs | ||
|
|
||
| # from rich.console import Console |
|
|
||
| def process_file(self, input_file: str, output_file: Optional[str] = None) -> str: | ||
| """Process a markdown file and return the result""" | ||
| with open(input_file, "r", encoding="utf-8") as f: |
There was a problem hiding this comment.
This isn't surrounded by a try... statement, are we sure this can't fail? e.g. file always exists, it is always a readable file format, it is always a markdown file?
|
|
||
| The `core.HierarchicalReconciliation` reconciliation class operates with | ||
| the hierarchical time series pd.DataFrame `Y_df`, the base predictions | ||
| pd.DataFrame `Y_hat_df`, the aggregation constraints matrix `S`. For |
|
|
||
| ::: hierarchicalforecast.evaluation.evaluate | ||
|
|
||
| ### Example |
There was a problem hiding this comment.
Where does this example come from?
| OTexts.com/fpp3 Accessed on July | ||
| 2022.](https://otexts.com/fpp3/hierarchical.html) | ||
|
|
||
| ### Optimal Reconciliation |
There was a problem hiding this comment.
This header can be removed imho, the references can just be added to the list under "General Reconciliation".
| ``` | ||
|
|
||
|
|
||
| ```python |
There was a problem hiding this comment.
Can be removed imho (the polars example)
| ) | ||
| ``` | ||
|
|
||
| ## External Forecast Adapters |
There was a problem hiding this comment.
The below function doesn't need to be in the docs - how to prevent it? Change the function to be private? (e.g. with a leading _?)
This PR does the migration from
lazydocstomkdocstrings