Skip to content

Conversation

@hogepodge
Copy link
Contributor

Proposal for documentation refactor. Changes include:

Major changes to top-level structure.
Separation of user and developer docs.
Reclassifying many tutorials as how-tos.
Moving sphinx galleries to top level "gallery" directory.
Consistent naming between galleries and top-level structure

do not merge

@Lunderberg
Copy link
Contributor

@areusch Do the CI nodes get fully cleaned before starting a new task, or do they just check out the PR's version?

If the latter, I think this PR may be causing unrelated PRs to fail CI. The CI gave errors about duplicate files existing in both the docs/user_tutorials folder existing and having duplicate labels as compared to other .rst files.

@mbs-octoml
Copy link
Contributor

mbs-octoml commented Aug 12, 2021

If the latter, I think this PR may be causing unrelated PRs to fail CI.

Dito for https://ci.tlcpack.ai/blue/organizations/jenkins/tvm/detail/PR-8597/40/pipeline/257/

@hogepodge
Copy link
Contributor Author

One reason for the failures may be that I'm actually duplicating files at this point as I'm trying to sort out a new structure.

@Lunderberg
Copy link
Contributor

Just put in #8735, which (crossing fingers) should resolve the CI issues.

@mbs-octoml
Copy link
Contributor

For posterity: The sphinx build was placing build files directly into the source tree. We rely on git checkout to keep the source tree 1:1 with the PR under test and thus hermetic, but this build trick broke that assumption.

hogepodge and others added 2 commits August 12, 2021 18:23
Proposal for documentation refactor. Changes include:

Major changes to top-level structure.
Separation of user and developer docs.
Reclassifying many tutorials as how-tos.
Moving sphinx galleries to top level "gallery" directory.
Consistent naming between galleries and top-level structure
@hogepodge hogepodge closed this Sep 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants