py-why / py-why/EconML

Host documentation for multiple verisons of the library

Open
#412 0 comments 0 reactions 1 assignee View on GitHub

@kbattocchi is already working on this.

Since Feb 19, 2021.

enhancement
Dominant language
Jupyter Notebook
Stars
4.8k
Forks
827
PR merge metrics
No merged PRs in 30d

Description

At the moment we host only the documentation for the latest released version of the library. However, this means that when we've released a beta with breaking changes, the documentation only covers a version of the library that most users won't ever see. Instead, we should change the organization of the documentation so that we have /latest/ and /stable/ versions of the documentation, while also making the docs for each released version available using a corresponding path (e.g. /0.8.0/).

Note that this will require rather major changes to our release pipeline since it's quite different from how we do things now.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.