~wahn/rs-pbrt

896e10f2585ad44657f8e1cc3a3cac941f9f957d — Jan Walter 5 months ago 1daa38e
Attempt to fix 'Read the Docs' build.
6 files changed, 24 insertions(+), 56 deletions(-)

M .readthedocs.yaml
M docs/Makefile
D docs/conf.py
A docs/index.rst
M docs/make.bat
M docs/source/conf.py
M .readthedocs.yaml => .readthedocs.yaml +1 -1
@@ 16,7 16,7 @@ build:

# Build documentation in the "docs/" directory with Sphinx
sphinx:
  configuration: docs/conf.py
  configuration: docs/source/conf.py
  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
  # builder: "dirhtml"
  # Fail on all warnings to avoid broken references

M docs/Makefile => docs/Makefile +1 -1
@@ 6,7 6,7 @@
SPHINXOPTS    ?=
SPHINXBUILD   ?= sphinx-build
SOURCEDIR     = source
BUILDDIR      = build
BUILDDIR      = _build

# Put it first so that "make" without argument is like "make help".
help:

D docs/conf.py => docs/conf.py +0 -52
@@ 1,52 0,0 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = 'rs-pbrt'
copyright = '2024, Jan Walter'
author = 'Jan Walter'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
\ No newline at end of file

A docs/index.rst => docs/index.rst +20 -0
@@ 0,0 1,20 @@
.. rs-pbrt documentation master file, created by
   sphinx-quickstart on Mon Jan 29 17:50:24 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to rs-pbrt's documentation!
===================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

M docs/make.bat => docs/make.bat +1 -1
@@ 8,7 8,7 @@ if "%SPHINXBUILD%" == "" (
	set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
set BUILDDIR=_build

if "%1" == "" goto help


M docs/source/conf.py => docs/source/conf.py +1 -1
@@ 39,7 39,7 @@ templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']


# -- Options for HTML output -------------------------------------------------