Temporarily disable rustdoc autogen #1101
Conversation
There was a problem hiding this comment.
Reviewable status: 1 of 1 LGTMs obtained, and pending CI: Bazel Dev / ubuntu-22.04, Cargo Dev / macos-13, Cargo Dev / ubuntu-22.04, Installation / macos-13, Installation / macos-14, Installation / ubuntu-22.04, Local / ubuntu-22.04, Publish image, Publish nativelink-worker-init, Publish nativelink-worker-lre-cc, Remote / large-ubuntu-22.04, asan / ubuntu-22.04, docker-compose-compiles-nativelink (20.04), docker-compose-compiles-nativelink (22.04), integration-tests (20.04), macos-13, pre-commit-checks, ubuntu-20.04 / stable, ubuntu-22.04, ubuntu-22.04 / stable, windows-2022 / stable
There was a problem hiding this comment.
I don't think this is a good idea.
The parser is fairly complex and fixing bugs "on-the-fly" while changing things in nativelink-configs is kind of a concious design choice. Essentially, the parser and the way we write docs need to be done in sync, because "freeform" writing docs would make it incredibly hard to adapt the parser to it.
Reviewed 2 of 2 files at r1, all commit messages.
Reviewable status: 1 of 1 LGTMs obtained, and pending CI: Cargo Dev / macos-13, Installation / macos-13, Installation / ubuntu-22.04, Remote / large-ubuntu-22.04
This reverts commit 3aa4f94.
Description
This fix is to temporarily disable rustdoc autogen in our docs site until we can stabilize the parser and establish rustdoc commenting standards properly in the codebase.
This change is