Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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:
Expand Down
6 changes: 6 additions & 0 deletions docs/source/module_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,9 @@ The HPKOT module

.. automodule:: seekpath.hpkot.tools
:members:


Warnings
--------

.. autoclass:: seekpath.SupercellWarning