Nicer Development Experience, take 2

[pradyunsg]

A couple of smaller changes, based off experience of working on #148 and #153.

[codecov-commenter]

Codecov Report

Merging #177 into master will not change coverage.
The diff coverage is 0.00%.

@@          Coverage Diff           @@
##           master    #177   +/-   ##
======================================
  Coverage    0.00%   0.00%           
======================================
  Files           2       2           
  Lines         228     234    +6     
======================================
- Misses        228     234    +6     

Flag	Coverage Δ
#pytests	0.00% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
sphinx_book_theme/__init__.py	0.00% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update af8a28c...f4e8d1e. Read the comment docs.

[chrisjsewell]

Heya, what were the issues you come across with the current setup?
I guess the only issue with rebuilding the whole documentation every time (I think thats what -a does?) is that its a pain when you're just playing around with SCSS.
Not so much for the current documentation here (because it's only a few pages), but thinking towards using this approach for messing around with larger sets of documentation.

[pradyunsg]

• coveralls broke
• changes to layout.html only get reflected on index (because that's the only page sphinx detected as outdated as per our extension in conf.py)
• including the generated css in the repository makes it significantly harder to cherry-pick/merge changes (unless we wanna un-compress the generated css, which I don't)
• dir -> sdist -> wheel doesn't work right now, IIUC.

[pradyunsg]

To be clear, I'm pretty sure I broke all these things in #172. 😅

[chrisjsewell]

😂 you gotta break some eggs to make an omelette

[pradyunsg]

Everything except coveralls should be working. Let's do coveralls in a follow up PR. :)

[chrisjsewell]

Yep I think if you push another commit codecov should be working again now

[pradyunsg]

You underestimate how lazy I am. 🙃

[chrisjsewell]

Ah turns out the codecov app wasn't enabled yet for sphinx-book-theme (this is done in the organisation setings)

[chrisjsewell]

@pradyunsg why did you break nox lol:

(base) markdown-it-py/$ nox                     
nox > Running session tests
nox > Creating virtual environment (virtualenv) using python3.7 in .nox/tests
nox > Command /Users/chrisjsewell/opt/miniconda3/bin/python3.7 -m virtualenv /Users/chrisjsewell/Documents/GitHub/markdown-it-py/.nox/tests failed with exit code 1:
ImportError: cannot import name 'DETACHED_PROCESS' from 'virtualenv.util.subprocess' (/Users/chrisjsewell/opt/miniconda3/lib/python3.7/site-packages/virtualenv/util/subprocess/__init__.py)

pypa/virtualenv@0cd009b

(had to mess around with my base conda environment, but fixed now)

[pradyunsg]

Any blockers to merging this? :)

[choldgraf]

I just tried the nox workflow and it seems to be taking forever to create the virtualenv. It's been sitting on

nox > Running session docs
nox > Re-using existing virtual environment at .nox/docs.
nox > pip install .[sphinx]

for about 5 minutes now. Is this expected? Is there any gotcha w/ nox that I'm missing? (I am on WSL if that matters)

it also seems like the "old" way of build docs (make html) is gone...I am a bit worred that we have adopted a more brittle and complex dev toolchain (nox) in lieu of a more standard and functioning one (make)...

[chrisjsewell]

FYI, I haven't had any issues with this; you've gotta expect on Windows, that everything's gonna be rubbush 😆
but yeh we should probably put the makefile back as an alternative

[pradyunsg]

for about 5 minutes now. Is this expected?

Do you have a virtualenv in the same folder? If so, you're probably hitting pypa/pip#2195, which... well, needs fixing. :)

but yeh we should probably put the makefile back as an alternative

Separate PR incoming.

[chrisjsewell]

@pradyunsg FYI @choldgraf is away for a bit now. I'm meaning to get round to properly looking at this soon (and sphinx-book-theme in general), but let me know if not merging is holding you up in any way on any of the other improvements

[pradyunsg]

Yea, I'd like us to merge this in.

We can make more changes in a follow up. This is blocking me from working on a couple of things right now (some of these changes are really nice QoL improvements).

[chrisjsewell]

Ok I'm going to merge, so now you have no excuses, and I expect everything done by the end of the weekend 🤣

[pradyunsg]

oh no. :P