From cda516dcdee54506e9ad7ffd29a3d0d169f49331 Mon Sep 17 00:00:00 2001 From: philipstarkey Date: Sat, 20 Jun 2020 18:12:50 +1000 Subject: [PATCH] Doc updates Renamed API reference URL to match labscript utils and updated config to fix bugs identified in labscript-suite/labscript-utils#57 --- docs/source/{api-reference => api}/index.rst | 0 docs/source/conf.py | 6 ++++-- docs/source/index.rst | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) rename docs/source/{api-reference => api}/index.rst (100%) diff --git a/docs/source/api-reference/index.rst b/docs/source/api/index.rst similarity index 100% rename from docs/source/api-reference/index.rst rename to docs/source/api/index.rst diff --git a/docs/source/conf.py b/docs/source/conf.py index 12d0968..2054978 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -133,8 +133,10 @@ # whether to use stable or latest version labscript_suite_doc_version = os.environ.get('READTHEDOCS_VERSION', 'latest') -if labscript_suite_doc_version not in ['stable', 'latest']: +if '.' in labscript_suite_doc_version: labscript_suite_doc_version = 'stable' +elif labscript_suite_doc_version not in ['stable', 'latest']: + labscript_suite_doc_version = 'latest' # add intersphinx references for each component for ls_prog in labscript_suite_programs: @@ -205,7 +207,7 @@ def setup(app): app.add_config_value('m2r_anonymous_references', False, 'env') app.add_config_value('m2r_disable_inline_math', False, 'env') app.add_directive('mdinclude', MdInclude) - app.add_stylesheet('custom.css') + app.add_css_file('custom.css') # generate the components.rst file dynamically so it points to stable/latest # of subprojects correctly diff --git a/docs/source/index.rst b/docs/source/index.rst index f5165a1..9626196 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,7 +11,7 @@ runmanager :hidden: :caption: DOCUMENTATION - api-reference/index + api/index .. toctree:: :maxdepth: 2