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

Add make serve to makefile #216

Merged
merged 4 commits into from Jun 14, 2017
Merged

Add make serve to makefile #216

merged 4 commits into from Jun 14, 2017

Conversation

@mlouielu
Copy link
Contributor

@mlouielu mlouielu commented Jun 5, 2017

Borrow from python/cpython documentation, add make serve to serve devgudie at localhost (port 8000).

If the doc didn't build up, it will first build up then serve the devguide.

@brettcannon
Copy link
Member

@brettcannon brettcannon commented Jun 5, 2017

Why do you want this? Since the devguide is entirely static and uses relative paths you can simply open up the files locally in the browser and have things render properly.

@willingc
Copy link
Collaborator

@willingc willingc commented Jun 5, 2017

Hi @mlouielu, My typical workflow is to make the docs content build for Sphinx. Next, I run python3 -m http.server to start a web server that will render things locally. Was there an advantage that you felt that make serve would have?

@mlouielu
Copy link
Contributor Author

@mlouielu mlouielu commented Jun 6, 2017

@brettcannon you are right, but some additional function like search will need someone to serve them.

@willingc python -m http.server will need to enter localhost:8000/_build/html in the navigation bar, but make serve will cover this, so you will only need to enter localhost:8000 to it.

@willingc
Copy link
Collaborator

@willingc willingc commented Jun 6, 2017

Thanks for clarifying @mlouielu. I'm fine with being consistent with the CPython doc build which uses serve. A few thoughts on the PR:

@matrixise
Copy link
Member

@matrixise matrixise commented Jun 6, 2017

@mlouielu in 3.7, I have added the support of a directory for python -m http.server with -d for example: python -m http.server -d _build/html/

@matrixise
Copy link
Member

@matrixise matrixise commented Jun 6, 2017

@mlouielu will you support the serve parameter on unix-like systems ?

Update: this comment is useless, sorry

@matrixise
Copy link
Member

@matrixise matrixise commented Jun 14, 2017

@willingc I have asked to @mlouielu to add the hostname localhost in the output.

Now for my part, I have tested the target serve of Makefile, and it's a success.

Do you think we could merge it ?

@willingc
Copy link
Collaborator

@willingc willingc commented Jun 14, 2017

Sure thing. Thanks @mlouielu and @matrixise.

@willingc willingc merged commit b8aa27a into python:master Jun 14, 2017
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
You can’t perform that action at this time.