Skip to content

Commit cc23b84

Browse files
committed
Attempt to fix docs
1 parent aa5749e commit cc23b84

File tree

5 files changed

+17
-5
lines changed

5 files changed

+17
-5
lines changed

.readthedocs.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
version: 2
1+
# TODO: Replace with .readthedocsv2.yml once the v2 format becomes supported
2+
requirements_file: docs/requirements.txt
3+
4+
build:
5+
image: latest
26

37
python:
4-
install:
5-
- path: docs/
8+
version: 3.6

.readthedocsv2.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version: 2
2+
3+
python:
4+
install:
5+
- path: docs/
6+
7+
mkdocs:
8+
configuration: docs/mkdocs.yml

docs/plugins/generators.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def on_page_read_source(self, _, page, config):
3030
if self.exists or page.file.name != "index":
3131
return
3232
source_lines = []
33-
with open("../README.md", encoding="utf-8") as file:
33+
with open("README.md", encoding="utf-8") as file:
3434
readme_html = markdown.markdown(file.read(), extensions=["mdx_partial_gfm"])
3535
readme_root = lxml.html.fromstring(readme_html)
3636
source_lines.append(self.get_title(readme_root))

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/

docs/mkdocs.yml renamed to mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ repo_url: https://github.com/orlnub123/django-class-settings
33
site_description: Effortless class-based settings for Django.
44
copyright: Copyright © 2018 orlnub123.
55
theme: readthedocs
6-
docs_dir: files
6+
docs_dir: docs/files
77

88
nav:
99
- Index: index.md

0 commit comments

Comments
 (0)