From 419cd1c438768a8ce7499d0f4abaffdaefe25e72 Mon Sep 17 00:00:00 2001 From: matthickford Date: Mon, 4 Oct 2021 17:51:03 +0200 Subject: [PATCH] Include README.md in Sphinx docs. --- docs/index.md | 19 +++++++++++++++++++ docs/index.rst | 21 --------------------- 2 files changed, 19 insertions(+), 21 deletions(-) create mode 100644 docs/index.md delete mode 100644 docs/index.rst diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..da312ec0 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,19 @@ +```{eval-rst} +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + source/modules +``` + +```{include} ../README.md +``` + +Indices and tables +================== + +```{eval-rst} +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` +``` diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 334edfcb..00000000 --- a/docs/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. langcodes documentation master file, created by - sphinx-quickstart on Fri Apr 16 21:32:52 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to langcodes's documentation! -===================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - source/modules - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search`