DOCS: refactor developer docs #538
Conversation
choldgraf
requested review from
damianavila and
jorisvandenbossche
and removed request for
damianavila
Co-authored-by: Damian Avila <damianavila82@yahoo.com.ar>
There was a problem hiding this comment.
This is a really nice improvement of the contributing docs, thanks a lot @choldgraf !
I did a read through and added some comments / questions.
| @nox.session | ||
| def compile(session): | ||
| if _should_install(session): | ||
| session.install(".") |
There was a problem hiding this comment.
Is this line needed? Because wouldn't that actually already install stb and compile the assets in a pip build env for installing the package?
There was a problem hiding this comment.
I think that we do need it, because this is what gives us the theme builder CLI, which is not bundle with it by default via install("."). Is that what you were asking?
Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
|
OK I believe I've addressed all of your suggestions and comments @jorisvandenbossche - I've "resolved" them via the github UI, let me know if I missed something! |
docs/conf.py
Outdated
| @@ -107,6 +107,13 @@ | |||
| }, | |||
| } | |||
|
|
|||
| html_sidebars = { | |||
| "contributing": [ | |||
There was a problem hiding this comment.
The contributing top-level page/directory doesn't exist anymore, so this has no effect?
There was a problem hiding this comment.
good point - I updated this in the latest commit
|
Thanks a lot @choldgraf ! |
This refactors and updates our developer documentation, with the following major changes:
contribute/and adds a redirect)