diff --git a/libc/docs/_static/custom.css b/libc/docs/_static/custom.css new file mode 100644 --- /dev/null +++ b/libc/docs/_static/custom.css @@ -0,0 +1,100 @@ +pre { + padding: 7px; +} + +div.document { + width: 90%; +} + +div.body { + max-width: 90%; +} + +div.note { + padding: 20px 20px 10px 20px; +} + +div.note p.admonition-title { + font-size: 130%; +} + +table.mapping { + width: 100%; +} + +table.mapping td { + width: 50%; + padding: 5px; +} + +table.mapping td.hed { + background: #606060; + color: #fefefe; + text-align: left; + border-bottom: 2px #fefefe solid; + font-weight: bold; +} + +table.mapping td.header { + background: #eeeeee; +} + +table.mapping td.content { + font-family: monospace; + padding-bottom: 15px; +} + +/* Workaround for a Safari bug that would otherwise make table cells less wide +than the containing text. This just sets it back to the default browser +property.*/ +td { + -webkit-hyphens: manual !important; +} + +div.sphinxsidebar .caption { + font-family: Helvetica, Verdana, sans-serif; + font-size: 10pt; + font-weight: bold; + color: #fefefe; + background: #606060; + margin-bottom: 0; + text-transform: uppercase; + padding: 7px; +} + +div.sphinxsidebar a, +div.sphinxsidebar a:hover { + border: none; +} + +div.sphinxsidebar li { + padding-left: 7px; + border-bottom: 1px solid #fefefe; +} + +div.sphinxsidebar li:hover { + background: #eeeeee; +} + +div.sphinxsidebar ul { + background: #e9e9e9; + margin: 0px; + padding: 0px; +} + +div.sphinxsidebar ul a { + font-family: Helvetica, Verdana, sans-serif; + font-size: 8pt; + display: block; + padding: 5px 0; + line-height: 14pt; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 100%; +} + +div.sphinxsidebar h3 { + /* Hide Navigation. */ + display: none; +} diff --git a/libc/docs/conf.py b/libc/docs/conf.py --- a/libc/docs/conf.py +++ b/libc/docs/conf.py @@ -48,9 +48,9 @@ # built documents. # # The short X.Y version. -version = '14.0' +# version = '14.0' # The full version, including alpha/beta/rc tags. -release = '14.0' +# release = '14.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -91,19 +91,24 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'haiku' +#html_theme = 'haiku' +html_theme = 'alabaster' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +html_theme_options = { + 'font_size': '11pt', + # Don't generate any links to GitHub. + 'github_button' : 'false', +} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +html_title = 'The LLVM C Library' # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None @@ -120,7 +125,13 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = [] +html_static_path = ['_static'] +# +#html_context = { +# 'css_files': [ +# '_static/libc.css' +# ], +# } # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/libc/docs/index.rst b/libc/docs/index.rst --- a/libc/docs/index.rst +++ b/libc/docs/index.rst @@ -1,13 +1,10 @@ -=============================================== -llvm-libc: An ISO C-conformant Standard Library -=============================================== +================== +The LLVM C Library +================== -**llvm-libc library is not complete. If you need a fully functioning libc right -now, you should continue to use your standard system libc.** - -.. contents:: Table of Contents - :depth: 4 - :local: +.. warning:: + The libc is not complete. If you need a fully functioning C library right + now, you should continue to use your standard system libraries. Introduction ============ @@ -36,34 +33,43 @@ ================ Most development is currently targeting x86_64 and aarch64 on Linux. Several -functions in llvm-libc have been tested on Windows. The Fuchsia platform is -slowly replacing functions from its bundled libc with functions from llvm-libc. +functions in the libc have been tested on Windows. The Fuchsia platform is +slowly replacing functions from its bundled libc with functions from this +project. ABI Compatibility ================= -llvm-libc is written to be ABI independent. Interfaces are generated using +The libc is written to be ABI independent. Interfaces are generated using LLVM's tablegen, so supporting arbitrary ABIs is possible. In it's initial -stages llvm-libc is not offering ABI stability in any form. +stages there is no ABI stability in any form. + +.. toctree:: + :hidden: + :maxdepth: 1 + :caption: Documentation -Other Interesting Documentation -=============================== + build_system + clang_tidy_checks + entrypoints + fuzzing + ground_truth_specification + header_generation + implementation_standard + api_test + layering + mechanics_of_public_api + redirectors + source_layout + strings + runtimes_build + stdio + math .. toctree:: + :hidden: + :maxdepth: 1 + :caption: External Links - build_system - clang_tidy_checks - entrypoints - fuzzing - ground_truth_specification - header_generation - implementation_standard - api_test - layering - mechanics_of_public_api - redirectors - source_layout - strings - runtimes_build - stdio - math + Source Code + Bug Reports