[libc][docs] reorganize documentation

This commit does a few things: * creates libc/docs/headers/ and moves all user API related headers under it. * updates paths and docgen * updates the top level index to put these headers under a new "Implementation Status" tab. * rename some of the files to be foo.rst for foo.h (except strings, which is currently a mix of string.h and stdlib.h) * update the heading of some files to be in the form foo.h.
llvm · Dec 5, 2024 · 14590c8 · 14590c8
1 parent 0964328
commit 14590c8
Show file tree

Hide file tree

Showing 17 changed files with 45 additions and 38 deletions.
diff --git a/libc/docs/complex.rst → libc/docs/headers/complex.rst b/libc/docs/complex.rst → libc/docs/headers/complex.rst
@@ -1,4 +1,4 @@
-.. include:: check.rst
+.. include:: ../check.rst
 
 =========
 complex.h

diff --git a/libc/docs/ctype.rst → libc/docs/headers/ctype.rst b/libc/docs/ctype.rst → libc/docs/headers/ctype.rst
@@ -1,4 +1,4 @@
-.. include:: check.rst
+.. include:: ../check.rst
 
 =======
 ctype.h

diff --git a/libc/docs/fenv.rst → libc/docs/headers/fenv.rst b/libc/docs/fenv.rst → libc/docs/headers/fenv.rst
@@ -1,4 +1,4 @@
-.. include:: check.rst
+.. include:: ../check.rst
 
 ======
 fenv.h

diff --git a/libc/docs/headers/index.rst b/libc/docs/headers/index.rst
@@ -0,0 +1,18 @@
+Implementation Status
+=====================
+
+.. toctree::
+   :maxdepth: 1
+
+   complex
+   ctype
+   fenv
+   math/index.rst
+   search
+   setjmp
+   signal
+   stdbit
+   stdio
+   strings
+   threads
+   time
diff --git a/libc/docs/math/index.rst → libc/docs/headers/math/index.rst b/libc/docs/math/index.rst → libc/docs/headers/math/index.rst
@@ -1,10 +1,10 @@
 .. _math:
 
-==============
-Math Functions
-==============
+======
+math.h
+======
 
-.. include:: ../check.rst
+.. include:: ../../check.rst
 
 .. raw:: html
 

diff --git a/libc/docs/math/log.rst → libc/docs/headers/math/log.rst b/libc/docs/math/log.rst → libc/docs/headers/math/log.rst
diff --git a/libc/docs/math/stdfix.rst → libc/docs/headers/math/stdfix.rst b/libc/docs/math/stdfix.rst → libc/docs/headers/math/stdfix.rst
@@ -2,7 +2,7 @@
 StdFix Functions
 ================
 
-.. include:: ../check.rst
+.. include:: ../../check.rst
 
 Standards and Goals
 -------------------

diff --git a/libc/docs/libc_search.rst → libc/docs/headers/search.rst b/libc/docs/libc_search.rst → libc/docs/headers/search.rst
@@ -1,8 +1,8 @@
-=============
-Search Tables
-=============
+========
+search.h
+========
 
-.. include:: check.rst
+.. include:: ../check.rst
 
 ---------------
 Source Location

diff --git a/libc/docs/setjmp.rst → libc/docs/headers/setjmp.rst b/libc/docs/setjmp.rst → libc/docs/headers/setjmp.rst
@@ -1,4 +1,4 @@
-.. include:: check.rst
+.. include:: ../check.rst
 
 ========
 setjmp.h

diff --git a/libc/docs/signal.rst → libc/docs/headers/signal.rst b/libc/docs/signal.rst → libc/docs/headers/signal.rst
@@ -1,4 +1,4 @@
-.. include:: check.rst
+.. include:: ../check.rst
 
 ========
 signal.h

diff --git a/libc/docs/stdbit.rst → libc/docs/headers/stdbit.rst b/libc/docs/stdbit.rst → libc/docs/headers/stdbit.rst
@@ -1,4 +1,4 @@
-.. include:: check.rst
+.. include:: ../check.rst
 
 ========
 stdbit.h

diff --git a/libc/docs/stdio.rst → libc/docs/headers/stdio.rst b/libc/docs/stdio.rst → libc/docs/headers/stdio.rst
@@ -1,8 +1,8 @@
-===============
-StdIO Functions
-===============
+=======
+stdio.h
+=======
 
-.. include:: check.rst
+.. include:: ../check.rst
 
 ---------------
 Source location

diff --git a/libc/docs/strings.rst → libc/docs/headers/strings.rst b/libc/docs/strings.rst → libc/docs/headers/strings.rst
@@ -2,7 +2,7 @@
 String Functions
 ================
 
-.. include:: check.rst
+.. include:: ../check.rst
 
 ---------------
 Source location

diff --git a/libc/docs/threads.rst → libc/docs/headers/threads.rst b/libc/docs/threads.rst → libc/docs/headers/threads.rst
@@ -1,4 +1,4 @@
-.. include:: check.rst
+.. include:: ../check.rst
 
 =========
 threads.h

diff --git a/libc/docs/date_and_time.rst → libc/docs/headers/time.rst b/libc/docs/date_and_time.rst → libc/docs/headers/time.rst
@@ -1,8 +1,8 @@
-=======================
-Date and Time Functions
-=======================
+======
+time.h
+======
 
-.. include:: check.rst
+.. include:: ../check.rst
 
 ---------------
 Source location

diff --git a/libc/docs/index.rst b/libc/docs/index.rst
@@ -64,19 +64,8 @@ stages there is no ABI stability in any form.
    :caption: Status
 
    compiler_support
-   date_and_time
-   math/index.rst
-   strings
-   stdio
-   stdbit
-   fenv
-   libc_search
+   headers/index.rst
    c23
-   ctype
-   complex
-   signal
-   threads
-   setjmp
 
 .. toctree::
    :hidden:

diff --git a/libc/utils/docgen/docgen.py b/libc/utils/docgen/docgen.py
@@ -161,7 +161,7 @@ def print_macros_rst(header: Header, macros: Dict):
 
 
 def print_impl_status_rst(header: Header, api: Dict):
-    print(".. include:: check.rst\n")
+    print(".. include:: ../check.rst\n")
 
     print("=" * len(header.name))
     print(header.name)