developer-portal / content

Content for the Fedora Developer Portal
https://developer.fedoraproject.org/
GNU General Public License v2.0
106 stars 250 forks source link

Update the Python docs #351

Closed encukou closed 3 years ago

encukou commented 3 years ago

Here's a big update to Python sections to keep them current. The content was already reviewed by Python SIG members Zbyszek and Miro in https://github.com/encukou/content/pull/1


Update the list of Python versions. Remove sections for recently removed interpreters.

Change the section order to put Multiple Pythons near the top, since this is one of the main selling points of Fedora wrt. Python.

Warn that pip installs third-party software.

Explain more clearly why virtual environments are preferred over Fedora packages for development.

Only keep the name "virtualenv" for environments created by the actual virtualenv tool; otherwise switch "virtual environment" or just "environment".

Update Flask docs to reflect best practice there. Add ESP32 to the MicroPython docs.

And further rewordings and reorganization.

encukou commented 3 years ago

I split the text out of habit (shorter lines make the source easier to read, at least to me). Since it doesn't affect the output, I'll keep the PR as it is. If you have a stronger opinion, feel free to reflow the text.

encukou commented 3 years ago

Can this be merged?

pvalena commented 3 years ago

Sure, LGTM.

Note that at this point, unfortunately, there's no way of generating the actual website (any help is welcome).

pvalena commented 3 years ago

On the second thought- have you reviewed the result, does it actually build for you? (I'd be much happier to merge this if I could actually see it rendered correctly.)

encukou commented 3 years ago

No, I couldn't get the actual website to work locally. I rendered the markdown files using a different tool.

pvalena commented 3 years ago

Ok, thanks for the message. That's good enough for me- I'll merge it then, and get back to you with if there are some visible issues.