diff options
author | Justin M. Keyes <justinkz@gmail.com> | 2022-09-23 11:36:36 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-09-23 08:36:36 -0700 |
commit | 3fe43917cbc95149d891d44b96d0798828021705 (patch) | |
tree | 63fdd05d5a13469a0e36968481bb01094c9f2561 /contrib/doxygen/footer.html | |
parent | 600136cfb641be450900f8b7a1bfdc4fbcb69856 (diff) | |
download | rneovim-3fe43917cbc95149d891d44b96d0798828021705.tar.gz rneovim-3fe43917cbc95149d891d44b96d0798828021705.tar.bz2 rneovim-3fe43917cbc95149d891d44b96d0798828021705.zip |
ci: remove contrib/doxygen/ #20303
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. https://github.com/neovim/neovim.github.io/pull/291
- Remove doxygen job from the neovim/doc repo. https://github.com/neovim/doc/pull/28
- Future/ongoing: ":help dev" and other :help docs will continue to be
improved as the "source of truth" for developer-related docs.
ref https://github.com/neovim/neovim/pull/824
Diffstat (limited to 'contrib/doxygen/footer.html')
-rw-r--r-- | contrib/doxygen/footer.html | 23 |
1 files changed, 0 insertions, 23 deletions
diff --git a/contrib/doxygen/footer.html b/contrib/doxygen/footer.html deleted file mode 100644 index a6d8bb1ee4..0000000000 --- a/contrib/doxygen/footer.html +++ /dev/null @@ -1,23 +0,0 @@ -<!-- HTML footer for doxygen 1.8.6--> -<!-- start footer part --> -<!--BEGIN GENERATE_TREEVIEW--> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - $navpath - <li class="footer">$generatedby - <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li> - </ul> -</div> -<!--END GENERATE_TREEVIEW--> -<!--BEGIN !GENERATE_TREEVIEW--> -<footer> - <div class="container"> - $generatedby - <a href="http://www.doxygen.org/index.html">Doxygen</a> - $doxygenversion - </div> -</footer> -<!--END !GENERATE_TREEVIEW--> -</body> -</html> |