Switch docs from reStructuredText to markdown.

Author: lhames

orc-rt/docs/Building-ORC-RT.rst renamed to orc-rt/docs/Building-orc-rt.md

@@ -1,25 +1,15 @@
-.. _Building_ORC_RT:
+# Building orc-rt
 
-==================
-Building ORC-RT
-==================
-
-.. contents::
-  :local:
-
-.. _build instructions:
-
-Getting Started
-===============
+## Getting Started
 
 The basic steps needed to build orc-rt are:
 
-#. Checkout llvm-project:
+* Checkout llvm-project:
 
    * ``cd where-you-want-llvm-to-live``
    * ``git clone https://github.com/llvm/llvm-project.git``
 
-#. Configure and build orc-rt:
+* Configure and build orc-rt:
 
    CMake is the only supported configuration system.
 
@@ -38,17 +28,14 @@ The basic steps needed to build orc-rt are:
    Shared and static libraries for orc-rt should now be present in
    llvm/build/lib.
 
-#. **Optional**: Install orc-rt
+* **Optional**: Install orc-rt
 
    Remember Use the CMake option ``CMAKE_INSTALL_PREFIX`` to select a safe
    place to install orc-rt.
 
    * ``make install-orc-rt`` --- Will install the libraries and the headers
 
-.. _CMake Options:
-
-CMake Options
-=============
+## CMake Options
 
 Here are some of the CMake variables that are used often, along with a
 brief explanation and LLVM-specific notes. For full documentation, check the
@@ -66,24 +53,21 @@ CMake docs or execute ``cmake --help-variable VARIABLE_NAME``.
 **CMAKE_CXX_COMPILER**:STRING
   The C++ compiler to use when building and testing orc-rt.
 
-.. _orc-rt-specific options:
-
-orc-rt specific options
---------------------------
+## orc-rt specific options
 
-.. option:: ORC_RT_ENABLE_ASSERTIONS:BOOL
+* option:: ORC_RT_ENABLE_ASSERTIONS:BOOL
 
   **Default**: ``ON``
 
   Toggle assertions independent of the build mode.
 
-.. option:: ORC_RT_ENABLE_PEDANTIC:BOOL
+* option:: ORC_RT_ENABLE_PEDANTIC:BOOL
 
   **Default**: ``ON``
 
   Compile with -Wpedantic.
 
-.. option:: ORC_RT_ENABLE_WERROR:BOOL
+* option:: ORC_RT_ENABLE_WERROR:BOOL
 
   **Default**: ``ON``
 

orc-rt/docs/conf.py

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
-#
-# orc-rt documentation build configuration file.
+# Orc-Rt documentation build configuration file.
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
@@ -10,9 +9,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
 from datetime import date
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -22,16 +19,32 @@
 
 # If your documentation needs a minimal Sphinx version, state it here.
 # needs_sphinx = '1.0'
-
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ["sphinx.ext.intersphinx", "sphinx.ext.todo"]
+extensions = [
+    "sphinx.ext.todo",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autodoc",
+]
+
+# When building man pages, we do not use the markdown pages,
+# So, we can continue without the myst_parser dependencies.
+# Doing so reduces dependencies of some packaged llvm distributions.
+try:
+    import myst_parser
+
+    extensions.append("myst_parser")
+except ImportError:
+    if not tags.has("builder-man"):
+        raise
+
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
+myst_heading_anchors = 6
 
-# The suffix of source filenames.
-source_suffix = ".rst"
+import sphinx
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
@@ -40,17 +53,19 @@
 master_doc = "index"
 
 # General information about the project.
-project = "orc-rt"
-copyright = "2021-%d, LLVM Project" % date.today().year
+project = "Orc-Rt"
+copyright = "2017-%d, The Orc-Rt Team" % date.today().year
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
-# built documents.
+# built documents. These are currently set to zero because we don't use them.
+# Should somebody consider in the future to change them, they need to be updated
+# everytime a new release comes out.
 #
-# The short X.Y version.
-version = "17.0"
+# The short version.
+# version = '0'
 # The full version, including alpha/beta/rc tags.
-release = "17.0"
+# release = '0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -60,11 +75,11 @@
 # non-false value, then it is used:
 # today = ''
 # Else, today_fmt is used as the format for a strftime call.
-today_fmt = "%Y-%m-%d"
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ["_build"]
+exclude_patterns = ["_build", "analyzer", "FIR/*"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 # default_role = None
@@ -78,7 +93,7 @@
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-show_authors = True
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "friendly"
@@ -103,7 +118,7 @@
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-# html_title = None
+html_title = "ORC Runtime"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 # html_short_title = None
@@ -120,11 +135,11 @@
 # 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 = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = "%b %d, %Y"
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
@@ -166,6 +181,9 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = "orc-rt-doc"
 
+# If true, the reST sources are included in the HTML build as
+# _sources/name. The default is True.
+html_copy_source = False
 
 # -- Options for LaTeX output --------------------------------------------------
 
@@ -181,7 +199,8 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ("contents", "orc-rt.tex", "orc-rt Documentation", "LLVM project", "manual"),
+    ("Overview", "Orc-Rt.tex", "orc-rt Documentation", "The orc-rt Team",
+     "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -209,7 +228,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [("contents", "orc-rt", "orc-rt Documentation", ["LLVM project"], 1)]
+man_pages = []
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -222,13 +241,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (
-        "contents",
-        "orc-rt",
-        "orc-rt Documentation",
-        "LLVM project",
-        "orc-rt",
-        "LLVM ORC Runtime",
-        "Miscellaneous",
+        "Overview",
     ),
 ]
 
@@ -240,13 +253,3 @@
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 # texinfo_show_urls = 'footnote'
-
-
-# FIXME: Define intersphinx configuration.
-intersphinx_mapping = {}
-
-
-# -- Options for extensions ----------------------------------------------------
-
-# Enable this if you want TODOs to show up in the generated documentation.
-todo_include_todos = True

orc-rt/docs/index.md

@@ -0,0 +1,54 @@
+# LLVM ORC Runtime
+
+## Overview
+
+The ORC runtime provides executor-side support code for the LLVM ORC APIs.
+
+```{eval-rst}
+.. toctree::
+   :titlesonly:
+
+   Building-orc-rt
+```
+
+### Current Status
+
+The ORC Runtime is a new, experimental project. It is being actively developed,
+and neither the ABI nor API are stable. LLVM ORC API clients should be careful
+to use an ORC Runtime from the same build as their LLVM ORC libraries.
+
+### Platform and Compiler Support
+
+* TODO
+
+The following minimum compiler versions are strongly recommended.
+
+* Clang 16 and above
+
+Anything older *may* work.
+
+### Notes and Known Issues
+
+* TODO
+
+## Getting Involved
+
+First please review our
+[Developer's Policy](https://llvm.org/docs/DeveloperPolicy.html) and
+[Getting started with LLVM](https://llvm.org/docs/GettingStarted.html).
+
+**Bug Reports**
+
+If you think you've found a bug in the ORC Runtime, please report it using
+the [LLVM bug tracker](https://github.com/llvm/llvm-project/labels/orc-rt/).
+Please use the tag "orc-rt" for new threads.
+
+**Patches**
+
+If you want to contribute a patch to th ORC runtime, please start by reading
+the LLVM
+[documentation about contributing](https://www.llvm.org/docs/Contributing.html).
+
+**Discussion and Questions**
+
+* TODO