Skip to content

Commit

Permalink
Add readthedocs config and slightly update Sphinx config (#205)
Browse files Browse the repository at this point in the history
  • Loading branch information
stevejalim committed Jan 25, 2024
1 parent dde305f commit 81b4824
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 4 deletions.
18 changes: 18 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

formats:
- pdf
24 changes: 20 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@

# General information about the project.
project = "Django-CSP"
copyright = "2016 Mozilla Foundation"
copyright = "2016-2024 Mozilla"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -181,7 +181,13 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
("index", "Django-CSP.tex", "Django-CSP Documentation", "James Socol, Mozilla", "manual"),
(
"index",
"Django-CSP.tex",
"Django-CSP Documentation",
"James Socol, Mozilla",
"manual",
),
]

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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [("index", "django-csp", "Django-CSP Documentation", ["James Socol, Mozilla"], 1)]
man_pages = [
("index", "django-csp", "Django-CSP Documentation", ["James Socol, Mozilla"], 1)
]

# If true, show URL addresses after external links.
# man_show_urls = False
Expand All @@ -221,7 +229,15 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
("index", "Django-CSP", "Django-CSP Documentation", "James Socol, Mozilla", "Django-CSP", "One line description of project.", "Miscellaneous"),
(
"index",
"Django-CSP",
"Django-CSP Documentation",
"James Socol, Mozilla",
"Django-CSP",
"CSP header-generation and reporting for Django applications",
"Miscellaneous",
),
]

# Documents to append as an appendix to all manuals.
Expand Down

0 comments on commit 81b4824

Please sign in to comment.