Skip to content

Commit

Permalink
Merge pull request #268 from Remi-Gau/fix/rtd
Browse files Browse the repository at this point in the history
[FIX] update read the docs config
  • Loading branch information
Remi-Gau authored Sep 5, 2024
2 parents 2b07dd0 + 3d0b972 commit f9cbf4d
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 5 deletions.
13 changes: 10 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,16 @@
.. |github-action-badge| image:: https://github.com/sphinx-contrib/matlabdomain/actions/workflows/python-package.yml/badge.svg
:align: middle

+----------------+-----------------------+
+ Github Actions | |github-action-badge| |
+----------------+-----------------------+
.. |rtd-badge| image:: https://readthedocs.org/projects/sphinxcontrib-matlabdomain/badge/?version=latest
:target: https://sphinxcontrib-matlabdomain.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
:align: middle

+----------------------+-----------------------+
+ Github Actions | |github-action-badge| |
+----------------------+-----------------------+
+ Documentation Status | |rtd-badge| |
+----------------------+-----------------------+

sphinxcontrib-matlabdomain -- Sphinx domain for auto-documenting MATLAB
=======================================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,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"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down
20 changes: 19 additions & 1 deletion readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
requirements_file: rtd-requirements.txt
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

build:
os: ubuntu-22.04
tools:
python: '3.12'

sphinx:
configuration: docs/conf.py
builder: html
fail_on_warning: false

python:
install:
- requirements: rtd-requirements.txt

0 comments on commit f9cbf4d

Please sign in to comment.