readthedocs.yml

# .. Copyright (C) 2012-2022 Bryan A. Jones.
#
#   This file is part of the CodeChat System.
#
#   The CodeChat System is free software: you can redistribute it and/or
#   modify it under the terms of the GNU General Public License as
#   published by the Free Software Foundation, either version 3 of the
#   License, or (at your option) any later version.
#
#   The CodeChat System is distributed in the hope that it will be
#   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
#   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
#   General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with the CodeChat System.  If not, see
#   <http://www.gnu.org/licenses/>.
#
# ***********************************
# |docname| - ReadTheDocs config file
# ***********************************
#
# Supporting files
# ================
# .. toctree::
#
#   docs/docs-requirements.txt
#
# Configuration
# =============
version: 2

python:
  install:
    # To build this documentation, install the required packages. See `requirements <https://docs.readthedocs.io/en/stable/config-file/v2.html#requirements-file>`_.
    - requirements: docs/docs-requirements.txt

# For some reason, the Read The Docs engine can't find `conf.py`. `Specify it explicitly <https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx-configuration>`_.
sphinx:
  configuration: conf.py