classification
Title: use the right python "make -C Doc/ serve"
Type: Stage: patch review
Components: Documentation Versions: Python 3.8
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: berker.peksag, docs@python, matrixise, mdk
Priority: normal Keywords: patch

Created on 2019-03-17 18:57 by matrixise, last changed 2019-05-01 15:23 by berker.peksag.

Pull Requests
URL Status Linked Edit
PR 12385 merged matrixise, 2019-03-17 19:03
Messages (5)
msg338135 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2019-03-17 18:57
When serving the documentation with `make -C Doc/ serve`, we can not specify the path of the python binary.

My use case, I wanted to debug the wsgiref.simple_server method, used by Tools/scripts/serve.py. It's just impossible because  we use the default python3 binary from the system or from the virtualenv (pyenv. etc...)
msg338195 - (view) Author: Julien Palard (mdk) * (Python committer) Date: 2019-03-18 10:48
New changeset 09a9f1799c8c58f573c50cb2d526422436b8658b by Julien Palard (Stéphane Wirtel) in branch 'master':
bpo-36329: Declare the version of Python to use for Tools/scripts/serve.py (#12385)
https://github.com/python/cpython/commit/09a9f1799c8c58f573c50cb2d526422436b8658b
msg341163 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2019-04-30 21:04
Personally, I'd prefer removing the 'serve' target completely. make -C Doc htmlview should already cover most of its use cases. There is no deprecation period needed and there is already a replacement (and IMO better) for it.
msg341204 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2019-05-01 14:57
>Personally, I'd prefer removing the 'serve' target completely. make -C
>Doc htmlview should already cover most of its use cases. There is no
>deprecation period needed and there is already a replacement (and IMO
>better) for it.

Hi Berker,

When I have read your message, I was surprised because this target
already exists since 2010. It's true we can run the makefile with 

my current workflow is 

make -C Doc/ venv && make -C Doc/ html serve and open my browser at
http://localhost:8000

but with your suggestion, I think it's better for us and also for the
contributors, just make -C Doc/ venv htmlview. This target will open the
browser with the result of the html build.

So, I have discussed with @Julien Palard and he told me that he did not
use the 'serve' target and he discovered the target via my issue.

But there will be an other issue, in the devguide, there is also a
'serve' target in the Makefile with a copy of tools/serve.py.

But there is no htmlview target. 

For the moment, we have a common solution for the two project if we want
to show the result to the user, make serve.

We could:

* remove 'make serve' from CPython and Devguide
* remove tools/serve.py from CPython and Devguide
* add htmlview to the DevGuide
* update the documentation 

+1 for removing the serve.py script and use htmlview.
msg341211 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2019-05-01 15:23
Yeah, we can add htmlview to devguide. I’ve even added it to Django after I
discovered it in CPython :)
-- 
--Berker
History
Date User Action Args
2019-05-01 15:23:08berker.peksagsetmessages: + msg341211
2019-05-01 14:57:15matrixisesetmessages: + msg341204
2019-04-30 21:04:59berker.peksagsetnosy: + berker.peksag
messages: + msg341163
2019-03-18 10:48:05mdksetnosy: + mdk
messages: + msg338195
2019-03-17 19:03:16matrixisesetkeywords: + patch
stage: patch review
pull_requests: + pull_request12342
2019-03-17 18:57:56matrixisesetassignee: docs@python

components: + Documentation
nosy: + docs@python
2019-03-17 18:57:38matrixisecreate