[libc][docs] reorganize documentation (#118836)

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.
This commit is contained in:
Nick Desaulniers
2024-12-05 13:54:09 -08:00
committed by GitHub
parent cfa582e8aa
commit a9aff440d9
17 changed files with 45 additions and 38 deletions

View File

@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst
=========
complex.h

View File

@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst
=======
ctype.h

View File

@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst
======
fenv.h

View File

@@ -0,0 +1,18 @@
Implementation Status
=====================
.. toctree::
:maxdepth: 1
complex
ctype
fenv
math/index.rst
search
setjmp
signal
stdbit
stdio
strings
threads
time

View File

@@ -1,10 +1,10 @@
.. _math:
==============
Math Functions
==============
======
math.h
======
.. include:: ../check.rst
.. include:: ../../check.rst
.. raw:: html

View File

@@ -2,7 +2,7 @@
StdFix Functions
================
.. include:: ../check.rst
.. include:: ../../check.rst
Standards and Goals
-------------------

View File

@@ -1,8 +1,8 @@
=============
Search Tables
=============
========
search.h
========
.. include:: check.rst
.. include:: ../check.rst
---------------
Source Location

View File

@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst
========
setjmp.h

View File

@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst
========
signal.h

View File

@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst
========
stdbit.h

View File

@@ -1,8 +1,8 @@
===============
StdIO Functions
===============
=======
stdio.h
=======
.. include:: check.rst
.. include:: ../check.rst
---------------
Source location

View File

@@ -2,7 +2,7 @@
String Functions
================
.. include:: check.rst
.. include:: ../check.rst
---------------
Source location

View File

@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst
=========
threads.h

View File

@@ -1,8 +1,8 @@
=======================
Date and Time Functions
=======================
======
time.h
======
.. include:: check.rst
.. include:: ../check.rst
---------------
Source location

View File

@@ -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:

View File

@@ -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)