diff --git a/docs/source/index.rst b/docs/source/index.rst index 2e4b9993c..5fb81b490 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,19 +6,13 @@ pypdfium2 .. _README.md: https://github.com/pypdfium2-team/pypdfium2#readme -| Welcome to the documentation for the support model of pypdfium2. -| For general information, please also refer to the project's `README.md`_ file. - -.. toctree:: - :maxdepth: 2 - :caption: Readme - - readme +Welcome to the documentation for the support model of pypdfium2. .. toctree:: :maxdepth: 2 :caption: Usage + readme python_api shell_api diff --git a/docs/source/readme.md b/docs/source/readme.md index c11746353..6f283bc5f 100644 --- a/docs/source/readme.md +++ b/docs/source/readme.md @@ -6,6 +6,9 @@ We'd like to rename the heading, but it looks like this is not currently possibl https://github.com/executablebooks/MyST-Parser/issues/628 --> +# Readme + ```{include} ../../README.md :relative-docs: docs/ +:start-after: "# pypdfium2" ```