Skip to content

[ENH] Add a separate documentation for pytorch-forecasting v1 and v2#2279

Draft
phoeenniixx wants to merge 1 commit into
sktime:mainfrom
phoeenniixx:v2-doc
Draft

[ENH] Add a separate documentation for pytorch-forecasting v1 and v2#2279
phoeenniixx wants to merge 1 commit into
sktime:mainfrom
phoeenniixx:v2-doc

Conversation

@phoeenniixx
Copy link
Copy Markdown
Member

Reference Issues/PRs

Fixes parts of #2277 (separation of v1 and v2)

What does this implement/fix? Explain your changes.

This PR create separate header for v2 documentation and creates clear distinction between both the versions and adds clearer api references

checklist for this PR

  • Add some references for v2 to readme as well
  • Create a new header for v2 API
  • Add API references
  • separate v2 models and datamodules from v1
  • Clearly mention that metrics are still the same as v1
  • make the models table automated and add new models which are not present. Waiting for [ENH] auto-generate model overview table from registry tags #2236 to complete
  • Add separate tutorials for v2 - should be easily distinguishable from v1

@phoeenniixx phoeenniixx added documentation Improvements or additions to documentation enhancement New feature or request labels May 10, 2026
@phoeenniixx phoeenniixx self-assigned this May 10, 2026
@felipeangelimvieira
Copy link
Copy Markdown

One possibility: use gh-pages and dump documentation to specific directories for each version. Example:
https://github.com/felipeangelimvieira/prophetverse/tree/gh-pages

There is a html at index that redirects to the latest version. You can then add a custom domain.

@phoeenniixx
Copy link
Copy Markdown
Member Author

Thanks a lot for sharing this! I will look into it

@felipeangelimvieira
Copy link
Copy Markdown

There's a CI that dumps the doc files when there's a release. You can also manually edit gh-pages branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants