Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build,Makefile: add 'make mkdocs-serve' #294

Merged
merged 5 commits into from
Jan 13, 2021
Merged

Conversation

meowsbits
Copy link
Contributor

This adds a script and associated Makefile command
to handle installing requirements and starting the
development server for mkdocs.

Signed-off-by: meows b5c6@protonmail.com

This adds a script and associated Makefile command
to handle installing requirements and starting the
development server for mkdocs.

Signed-off-by: meows <b5c6@protonmail.com>
@ziogaschr
Copy link
Member

I wonder if we should add the creation of a virtualenv within the script. As it currently installs the packages globally in the system.

Though not all the developers know/like how to use virtualenvs and at the end a ~/.virtualenv/ dir will be created.

@meowsbits
Copy link
Contributor Author

meowsbits commented Jan 12, 2021

Maybe we should just use mkdocs if it's available in the PATH, or exit 1 with some help message about needing to install mkdocs and where to look to do that.

Then we get to have no opinions about Python or environments...

@ziogaschr
Copy link
Member

No strong preference on this one. I liked the idea of your script as core-geth is a go project and their users might not know much about python, while most systems have python installed.

@meowsbits
Copy link
Contributor Author

meowsbits commented Jan 13, 2021

I'm OK leaving outvirtualenv business. The main reason I had any python management stuff in there was to give context (or an excuse) for putting the python install -r requirements-mkdocs.txt in the code somewhere for sake of documentation. Will push a change to simplify this (and trim responsibility).

EDIT: @ziogaschr Just saw your commit 946fa86 -- LGTM.

@ziogaschr
Copy link
Member

Would it make sense adding this in both README and docs? Something across the lines of using MkDocs and here is how to install it and run it locally.

It was getting assigned only before the python
command was finally assigned.

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits meowsbits force-pushed the feat/makefile-mkdocs-serve branch from bc08bdf to aaed10b Compare January 13, 2021 12:47
Date: 2021-01-13 06:42:04-06:00
Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits meowsbits force-pushed the feat/makefile-mkdocs-serve branch from aaed10b to 54d5589 Compare January 13, 2021 12:47
Copy link
Member

@ziogaschr ziogaschr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: meows <b5c6@protonmail.com>
@meowsbits meowsbits merged commit 3fab56b into master Jan 13, 2021
@meowsbits meowsbits deleted the feat/makefile-mkdocs-serve branch January 13, 2021 12:55
@meowsbits meowsbits mentioned this pull request Jan 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants