diff --git a/.readthedocs.yml b/.readthedocs.yml index 0757b52..9da4ebc 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -6,11 +6,20 @@ version: 2 # Only compile HTML formats: [] +build: + os: 'ubuntu-24.04' + tools: + python: '3.13' + python: - version: 3.8 install: - requirements: docs/requirements_for_rtd.txt - method: pip path: . - #extra_requirements: - # - docs + extra_requirements: + - 'bz' + +sphinx: + configuration: 'docs/source/conf.py' + builder: 'html' + fail_on_warning: false diff --git a/docs/source/conf.py b/docs/source/conf.py index 0a608bf..8436b84 100755 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -33,7 +33,7 @@ templates_path = ['_templates'] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = {'.rst': 'restructuredtext'} # The encoding of source files. # source_encoding = 'utf-8-sig' @@ -67,7 +67,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: diff --git a/docs/source/module_guide/index.rst b/docs/source/module_guide/index.rst index b179216..01ab808 100644 --- a/docs/source/module_guide/index.rst +++ b/docs/source/module_guide/index.rst @@ -20,3 +20,9 @@ The HPKOT module .. automodule:: seekpath.hpkot.tools :members: + + +Warnings +-------- + +.. autoclass:: seekpath.SupercellWarning