Skip to content

Commit

Permalink
Added Read the Docs config file
Browse files Browse the repository at this point in the history
  • Loading branch information
hbldh committed Aug 28, 2023
1 parent 03deda3 commit 91d453a
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 9 deletions.
13 changes: 13 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"

sphinx:
configuration: docs/conf.py

python:
install:
- requirements: requirements-dev.txt
18 changes: 9 additions & 9 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,18 +53,18 @@
master_doc = "index"

# General information about the project.
project = u"PyEFD"
copyright = u"2020, Henrik Blidh"
author = u"Henrik Blidh"
project = "PyEFD"
copyright = "2020, Henrik Blidh"
author = "Henrik Blidh"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u"1.0"
version = "1.6.0"
# The full version, including alpha/beta/rc tags.
release = u"1.0"
release = "1.6.0"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -116,7 +116,7 @@

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

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down Expand Up @@ -229,7 +229,7 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, "PyEFD.tex", u"PyEFD Documentation", u"Henrik Blidh", "manual")
(master_doc, "PyEFD.tex", "PyEFD Documentation", "Henrik Blidh", "manual")
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down Expand Up @@ -257,7 +257,7 @@

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "pyefd", u"PyEFD Documentation", [author], 1)]
man_pages = [(master_doc, "pyefd", "PyEFD Documentation", [author], 1)]

# If true, show URL addresses after external links.
# man_show_urls = False
Expand All @@ -272,7 +272,7 @@
(
master_doc,
"PyEFD",
u"PyEFD Documentation",
"PyEFD Documentation",
author,
"PyEFD",
"One line description of project.",
Expand Down
4 changes: 4 additions & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
numpy
sphinx
sphinx-rtd-theme
pytest

0 comments on commit 91d453a

Please sign in to comment.