search

coderefinery / sphinx-lesson

Sphinx extension for creating CodeRefinery lessons
https://coderefinery.github.io/sphinx-lesson/
MIT License
15 stars 20 forks source link

local development server #32

Closed mehimself closed 4 years ago

mehimself commented 4 years ago

Do we have a convenient solution to preview/test our development locally? I consider adding a development server wrapper in python. But I rarely develop in python so I might miss something obvious. What is the most practicable setup for you?

mehimself commented 4 years ago

I added a make file which hosts the site at localhost:8000 and auto-compiles/live-reloads

rkdarst commented 4 years ago

Great, thanks! I'll be interested to try this out.

Some things I'd recommend:

pull requests always better, especially once we start having multiple people working on this. I usually try to do that, too.

Adding sphinx-autobuild to requirements.txt makes it a dependency of all installations. I've usually thought that things for local building shouldn't be in requirements files, since it's the user's choice how to make and build it. But, this is a very small dependency, and the benefits for usability are probably high. What do you think?

For the coderefinery branding, I was going to make a Sphinx extension for coderefinery, that adds in the favicon. I will follow up on this once I can.