Move docs dependencies as part of extras

mozilla · May 15, 2020 · 306d1a4 · 306d1a4
1 parent 9c33508
commit 306d1a4
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 37 deletions.
diff --git a/.gitignore b/.gitignore
@@ -31,4 +31,7 @@ coverage.xml
 .coverage
 
 # Ignore tox installation
-.tox
+.tox
+
+# Docs generation
+docs.egg-info
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -7,5 +7,7 @@ python:
   install:
     - method: pip
       path: .
+      extra_requirements:
+        - docs
 mkdocs:
   configuration: mkdocs.yml
diff --git a/docs/common_tasks.md b/docs/common_tasks.md
@@ -7,7 +7,7 @@ that makes working on the docs locally much easier.
 
 ```console
 % pip install poetry
-% poetry install
+% poetry install --extras "docs"
 % poetry run mkdocs serve
 ```
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -11,10 +11,14 @@ authors = ["Mozilla"]
 [tool.poetry.dependencies]
 python = "^3.7"
 
-[tool.poetry.dev-dependencies]
-mkdocs = "1.0.4"
-mkdocs-material = "==4.6.3"
-mdx_truly_sane_lists = "1.2"
+# A list of all of the optional dependencies, some of which are included in the
+# below `extras`. They can be opted into by apps.
+mkdocs = { version = "1.0.4", optional = true }
+mkdocs-material = { version = "4.6.3", optional = true }
+mdx_truly_sane_lists = { version = "1.2", optional = true }
+
+[tool.poetry.extras]
+docs = ["mkdocs", "mkdocs-material", "mdx_truly_sane_lists"]
 
 [tool.black]
 line-length = 100