Nicer Development Experience, take 2

.gitignore

@@ -135,5 +135,5 @@ dmypy.json
 # VS Code
 .vscode/
 
-# Auto-generated docs page
-docs/contributing-ebp.md
+# Auto-generated CSS
+sphinx-book-theme.css

.pre-commit-config.yaml

@@ -26,12 +26,7 @@ repos:
     hooks:
     - id: black
 
-  - repo: local
+  - repo: https://github.com/mgedmin/check-manifest
+    rev: "0.39"
     hooks:
-    - id: scss
-      name: boussole
-      types: [scss]
-      language: python
-      additional_dependencies: [boussole]
-      entry: boussole compile --config=.boussole.json
-      pass_filenames: false
+    - id: check-manifest

MANIFEST.in

@@ -0,0 +1,24 @@
+exclude .binder
+recursive-exclude .binder *
+exclude docs
+recursive-exclude docs *
+exclude tests
+recursive-exclude tests *
+
+exclude .flake8
+exclude .pre-commit-config.yaml
+exclude .readthedocs.yml
+exclude .boussole.json
+exclude noxfile.py
+
+include CHANGELOG.md
+include LICENSE
+include MANIFEST.in
+include README.md
+
+include sphinx_book_theme/theme.conf
+recursive-include sphinx_book_theme *.html
+recursive-include sphinx_book_theme *.js
+recursive-include sphinx_book_theme *.png
+recursive-include sphinx_book_theme *.scss
+recursive-include sphinx_book_theme *.svg

docs/conf.py

@@ -73,14 +73,3 @@
     # "extra_navbar": "<a href='https://google.com'>Test</a>",
 }
 html_baseurl = "https://sphinx-book-theme.readthedocs.io/en/latest/"
-
-# -- Custom configuration ---------------------------------------------------
-
-
-# Always regenerate the index page, to ensure assets are correctly copied.
-def env_get_outdated(app, env, added, changed, removed):
-    return ["index"]
-
-
-def setup(app):
-    app.connect("env-get-outdated", env_get_outdated)

noxfile.py

@@ -69,6 +69,6 @@ def docs_live(session):
             # open the browser after 5 seconds
             "--open-browser",
             # sphinx-build arguments
-            "-b", "html", "docs", "docs/_build/html",
+            "-a", "-b", "html", "docs", "docs/_build/html",
         )
         # fmt: on

setup.py

@@ -66,10 +66,14 @@
     package_data={
         "sphinx_book_theme": [
             "theme.conf",
+            # Templates
             "*.html",
+            "topbar/*.html",
+            # Stylesheets
+            "scss/*",
+            # Other static files
             "static/*",
             "static/images/*",
-            "topbar/*.html",
         ]
     },
     include_package_data=True,

sphinx_book_theme/__init__.py

@@ -4,7 +4,7 @@
 from docutils import nodes
 from sphinx.util import logging
 from bs4 import BeautifulSoup as bs
-
+from sass import compile as sass_compile
 
 from .launch import add_hub_urls
 
@@ -22,6 +22,13 @@ def add_static_path(app):
     static_path = Path(__file__).parent.joinpath("static").absolute()
     app.config.html_static_path.append(str(static_path))
 
+    # Compile the css file if it's not been compiled already
+    compiled_css_file = static_path / "sphinx-book-theme.css"
+    if not compiled_css_file.exists():
+        source_dir = str(static_path.parent / "scss")
+        output_dir = str(static_path)
+        sass_compile(dirname=(source_dir, output_dir), output_style="compressed")
+
 
 def find_url_relative_to_root(pagename, relative_page, path_docs_source):
     """Given the current page (pagename), a relative page to it (relative_page),