ci: remove contrib/doxygen/ #20303
Merged
ci: remove contrib/doxygen/ #20303
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem: - The layout of the doxygen HTML "dev docs" has been broken for 1+ years. - There is no evidence that anyone uses the doxygen HTML. - In the meantime since we introduced the doxygen HTML pages, the Nvim C docstrings have been surfaced in other ways: - Nvim LSP client - Generated :help docs like ":help api" and ":help ui". Solution: - Remove `contrib/doxygen/` from neovim repo. - Note: keep `src/Doxyfile`, it is used by `scripts/gen_vimdoc.py`. ☠️ - Remove `doc/dev/` from website. neovim/neovim.github.io#291 - Remove doxygen job from the neovim/doc repo. neovim/doc#28 - Future/ongoing: ":help dev" and other :help docs will continue to be improved as the "source of truth" for developer-related docs. ref neovim#824
lvimuser
pushed a commit
to lvimuser/neovim
that referenced
this pull request
Oct 6, 2022
Problem: - The layout of the doxygen HTML "dev docs" has been broken for 1+ years. - There is no evidence that anyone uses the doxygen HTML. - In the meantime since we introduced the doxygen HTML pages, the Nvim C docstrings have been surfaced in other ways: - Nvim LSP client - Generated :help docs like ":help api" and ":help ui". Solution: - Remove `contrib/doxygen/` from neovim repo. - Note: keep `src/Doxyfile`, it is used by `scripts/gen_vimdoc.py`. ☠️ - Remove `doc/dev/` from website. neovim/neovim.github.io#291 - Remove doxygen job from the neovim/doc repo. neovim/doc#28 - Future/ongoing: ":help dev" and other :help docs will continue to be improved as the "source of truth" for developer-related docs. ref neovim#824
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem:
Solution:
contrib/doxygen/from neovim repo.src/Doxyfile, it is used byscripts/gen_vimdoc.py. ☠️doc/dev/from website. remove doxgygen docs neovim.github.io#291ref #824