Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[libc][docs] reorganize documentation #118836

Merged
merged 1 commit into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion libc/docs/complex.rst → libc/docs/headers/complex.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst

=========
complex.h
Expand Down
2 changes: 1 addition & 1 deletion libc/docs/ctype.rst → libc/docs/headers/ctype.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst

=======
ctype.h
Expand Down
2 changes: 1 addition & 1 deletion libc/docs/fenv.rst → libc/docs/headers/fenv.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst

======
fenv.h
Expand Down
18 changes: 18 additions & 0 deletions libc/docs/headers/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Implementation Status
=====================

.. toctree::
:maxdepth: 1

complex
ctype
fenv
math/index.rst
search
setjmp
signal
stdbit
stdio
strings
threads
time
8 changes: 4 additions & 4 deletions libc/docs/math/index.rst → libc/docs/headers/math/index.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. _math:

==============
Math Functions
==============
======
math.h
======

.. include:: ../check.rst
.. include:: ../../check.rst

.. raw:: html

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
StdFix Functions
================

.. include:: ../check.rst
.. include:: ../../check.rst

Standards and Goals
-------------------
Expand Down
8 changes: 4 additions & 4 deletions libc/docs/libc_search.rst → libc/docs/headers/search.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
=============
Search Tables
=============
========
search.h
========

.. include:: check.rst
.. include:: ../check.rst

---------------
Source Location
Expand Down
2 changes: 1 addition & 1 deletion libc/docs/setjmp.rst → libc/docs/headers/setjmp.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst

========
setjmp.h
Expand Down
2 changes: 1 addition & 1 deletion libc/docs/signal.rst → libc/docs/headers/signal.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst

========
signal.h
Expand Down
2 changes: 1 addition & 1 deletion libc/docs/stdbit.rst → libc/docs/headers/stdbit.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst

========
stdbit.h
Expand Down
8 changes: 4 additions & 4 deletions libc/docs/stdio.rst → libc/docs/headers/stdio.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
===============
StdIO Functions
===============
=======
stdio.h
=======

.. include:: check.rst
.. include:: ../check.rst

---------------
Source location
Expand Down
2 changes: 1 addition & 1 deletion libc/docs/strings.rst → libc/docs/headers/strings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
String Functions
================

.. include:: check.rst
.. include:: ../check.rst

---------------
Source location
Expand Down
2 changes: 1 addition & 1 deletion libc/docs/threads.rst → libc/docs/headers/threads.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: check.rst
.. include:: ../check.rst

=========
threads.h
Expand Down
8 changes: 4 additions & 4 deletions libc/docs/date_and_time.rst → libc/docs/headers/time.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
=======================
Date and Time Functions
=======================
======
time.h
======

.. include:: check.rst
.. include:: ../check.rst

---------------
Source location
Expand Down
13 changes: 1 addition & 12 deletions libc/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion libc/utils/docgen/docgen.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading