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/header.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/header.html')
-rw-r--r-- | contrib/doxygen/header.html | 36 |
1 files changed, 0 insertions, 36 deletions
diff --git a/contrib/doxygen/header.html b/contrib/doxygen/header.html deleted file mode 100644 index c9c1509d86..0000000000 --- a/contrib/doxygen/header.html +++ /dev/null @@ -1,36 +0,0 @@ -<!-- HTML header for doxygen 1.8.6--> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen $doxygenversion"/> -<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME--> -<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME--> -<script type="text/javascript" src="$relpath^jquery.js"></script> -<script type="text/javascript" src="$relpath^dynsections.js"></script> -$treeview -$search -$mathjax -<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" /> -$extrastylesheet -<link href="http://fonts.googleapis.com/css?family=Lato:400,700,900" rel="stylesheet"> -</head> -<body> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> - -<!--BEGIN TITLEAREA--> -<header class="navbar"> - <div class="container"> - <nav class="site-nav"> - <ul> - <li><a href="http://neovim.io/">Neovim Home</a></li> - </ul> - </nav> - <a href="$relpath^index.html"> - <img src="$relpath^$projectlogo" class="logo" alt="Neovim Dev-Doc"> - </a> - </div> -</header> -<!--END TITLEAREA--> -<!-- end header part --> |