Docs/mkdocs site - #9
Open
danilyef wants to merge 15 commits into
Open
Conversation
- Add mkdocs.yml, GitHub Actions deploy workflow, and a full docs/ site (index, introduction, getting started, how-to guides, benchmarks, deployment, pro, contributing, and mkdocstrings-generated API reference). - Unify all docstrings in src/tirex2 to NumPy style (previously mixed with Google-style Args: blocks), and add runnable usage examples to load_model, ForecastModel.forecast, TimeseriesType, and Demo. - Fix stale "NXAI Community License" references in the inference Dockerfiles, app/test file headers, and inference/README.md to Apache-2.0 — TiRex-2 is fully Apache-2.0; that license only applied to TiRex-1. - Add CONTRIBUTING.md (adapted from TiRex-1's, updated for this repo's Pixi/pre-commit/MkDocs tooling) and a docs status badge to README.md.
- Set the TiRex dino SVG (docs/images/tirex.svg) as the Material theme logo and favicon instead of the default icon. - Add a Docker/GHCR badge to README.md, matching the one already on the docs landing page, linking to the tirex2-cpu package.
- Copy the sine-wave and multivariate example images into docs/images/ and embed them in the fitting sections of the Quickstart and Forecasting how-to pages (switching Quickstart off the hotlinked GitHub raw URLs to local, self-contained images). - Add the two existing (previously unused) covariate demo renders (nonstationary driver + holiday flag) to the Covariates how-to page, matching Demo.create_nonstationary_demo() and Demo.create_holidays_demo(). - Add the "Open in Colab" badge to the Quickstart page and the docs landing page badge row, matching README.
- Add docs/about.md with NXAI's company description, logo (light/dark variants via Material's #only-light/#only-dark), and links to their website/GitHub/Hugging Face/LinkedIn. - Fix "NX-AI's open-source release" -> "NXAI's" on the landing page (NX-AI is the GitHub/HF org slug; NXAI is the company name). - Enable navigation.tabs (+ sticky) and navigation.path in mkdocs.yml, turning top-level sections into a sticky tab bar with breadcrumbs, and add the attr_list extension to size the logo images.
Add the same BibTeX citation block used in README.md and introduction.md to the docs landing page, matching TiRex-1's pattern of surfacing the citation prominently on the home page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary: