Include links to API reference in Sphinx (#320)

GillianPlatform · Nov 19, 2024 · 34a1de3 · 34a1de3
1 parent e8e1047
commit 34a1de3
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/_docs/README.md b/_docs/README.md
@@ -6,9 +6,9 @@
 
 This code is automatically built and pushed from the [main Gillian repository](https://github.com/GillianPlatform/Gillian/tree/master/sphinx).
 
-See the deployed docs [here](https://github.com/GillianPlatform/GillianPlatform.github.io).
+See the deployed docs [here](https://GillianPlatform.github.io).
 <br/>
-The API reference is available [here](https://GillianPlatform.github.io/api/).
+The API reference is available [here](https://GillianPlatform.github.io/odoc/).
 
 -----
 

diff --git a/sphinx/conf.py b/sphinx/conf.py
@@ -76,7 +76,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'doc_gen']
+exclude_patterns = ['README.md', '_build', 'Thumbs.db', '.DS_Store', 'doc_gen']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'lovelace'

diff --git a/sphinx/index.rst b/sphinx/index.rst
@@ -22,5 +22,6 @@ Gillian is a multi-language analysis platform supporting, e.g., verification and
    :titlesonly:
    :caption: About Gillian
 
+   API reference </odoc#http://>
    publications/index
    license