pytorch / pytorch/pytorch.github.io

Documentation should build to a folder with a -rc name.

Open
#994 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
285
Forks
317
PR merge metrics
No merged PRs in 30d

Description

📚 Documentation

Right now, we push /docs straight into a named folder by minor version number. This will cause our next RC to build into the stable version directly. We should build into a minor_version-rc folder so that we can copy the output into the appropriate version folder for stable at release.

Worked through this with @mattip and he has said he will create a PR for the issue.

cc @holly1238 @malfet

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.

Research direction

Find the documentation build configuration that currently pushes /docs into the minor-version folder. Update the build destination so release candidates use a minor_version-rc folder, then verify the output can be copied into the stable version folder at release.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.