pypy.org : Updating the current pypy.org webpage - removing yatiblog README and adding new nikola system instructions ?
Hello pypy.org webmasters, while discussing with Armin Rigo the update of the documentation of sandbox-2 on pypy.org, I realised, that the README (in the root dir of the pypy.org repo) is still pointing to the old yatiblog pages (source/README - which contains the old yatiblog instructions). Is someone taking care of updating the instructions to the new Nikola system (and removing the yatiblog source folder) ? Otherwise I could offer to do a new merge request with the changes. With kind regards, mark -------- Forwarded Message -------- Subject: Re: pypy-sandbox-2 - documentation fix. Branch uploaded Date: Sun, 29 Mar 2020 18:41:52 +0200 From: mark doerr <mark.doerr@uni-greifswald.de> Organization: University Greifswald To: Armin Rigo <arigo@tunes.org> Hi Armin, on a second look, I realised, that pypy moved from yatiblog to nikola. Is that true ? Then the README.rst in root is wrong: it still points to source/README (which is the old yatiblog pages and gives yatiblog instructions). Are the pages in the "pages" folder be used currently by your system (I guess that nikola takes the pages from "pages" to build the static html) ? Maybe the main README should also be updated ? Is someone taking care of this ? With kind regards, mark On 3/29/20 6:09 PM, mark doerr wrote:
Hi Armin,
I wondering, why you had two different repos, one and github and one on foss.
It is good that you bundled the development on one site.
It is not a big problem, that you deleted my files, I still have them as a local copy.
I will add the changes to the repo on foss.heptapod tonight (I just realised, that the pypy people use yatiblog - it seems that it converts reStructured text into static html, which is nice.)
In my old commit, I changed the generated html code directly, which was not nice ;)
I will send you a note, when changes are in ...
A bientôt,
mark
On 3/29/20 2:19 PM, Armin Rigo wrote:
Hi Mark,
Oops. We lost your pull request on https://github.com/pypy/pypy-website because we killed that repo (which was never meant to be there). The real repo is at https://foss.heptapod.net/pypy/pypy.org . If you still have your changes locally, could you make a merge request on the real repo? Thank you!
A bientôt,
Armin.
-
You're welcome, Matti, thanks for you fast reply. I will make a proposal for an update. Just one question/comment, since you are at the very beginning of your new repository: On our SiLA python repository ( https://gitlab.com/SiLA2/sila_python ) we are just using sphinx to generate the gitLAB static html pages: https://sila2.gitlab.io/sila_python/ With the python_docs_theme they have exactly the same look as the python.org pages. CI/CD pipeline generation is as simple as (see https://gitlab.com/SiLA2/sila_python/-/blob/master/.gitlab-ci.yml ) : pages: script: - pip install sphinx sphinx-rtd-theme python_docs_theme - cd docs ; make html - mv _build/html/ ../public/ artifacts: paths: - public only: - master That's it. No extra tools, no extra dependency, just python standard documentation tools everyone uses anyway and the final result is very nice and close to what people see from python.org. It is also very easy to include the pypy source code documentation with autodoc in the html generation. I do not know, if that was considered, if not, it might be worth considering before doing the final move to nikola. With best regards, mark On 3/30/20 10:10 AM, Matti Picus wrote:
On 29/3/20 11:43 pm, mark doerr wrote:
Hello pypy.org webmasters,
while discussing with Armin Rigo the update of the documentation of sandbox-2 on pypy.org, I realised,
that the README (in the root dir of the pypy.org repo) is still pointing to the old yatiblog pages (source/README - which contains the old yatiblog instructions).
Is someone taking care of updating the instructions to the new Nikola system (and removing the yatiblog source folder) ?
Otherwise I could offer to do a new merge request with the changes.
With kind regards,
mark
Yes thanks, that would be great. The README-DO-NOT-EDIT should be merged into the README and adjusted, and all directions should point to running "make" in the top level directory. "make help" could also be improved with a bit more verbosity. There may also be some stray files around that can be deleted.
Matti
-------- Forwarded Message -------- Subject: Re: pypy-sandbox-2 - documentation fix. Branch uploaded Date: Sun, 29 Mar 2020 18:41:52 +0200 From: mark doerr <mark.doerr@uni-greifswald.de> Organization: University Greifswald To: Armin Rigo <arigo@tunes.org>
Hi Armin,
on a second look, I realised, that pypy moved from yatiblog to nikola.
Is that true ? Then the README.rst in root is wrong: it still points to source/README (which is the old yatiblog pages and gives yatiblog instructions).
Are the pages in the "pages" folder be used currently by your system (I guess that nikola takes the pages from "pages" to build the static html) ?
Maybe the main README should also be updated ? Is someone taking care of this ?
With kind regards,
mark
On 3/29/20 6:09 PM, mark doerr wrote:
Hi Armin,
I wondering, why you had two different repos, one and github and one on foss.
It is good that you bundled the development on one site.
It is not a big problem, that you deleted my files, I still have them as a local copy.
I will add the changes to the repo on foss.heptapod tonight (I just realised, that the pypy people use yatiblog - it seems that it converts reStructured text into static html, which is nice.)
In my old commit, I changed the generated html code directly, which was not nice ;)
I will send you a note, when changes are in ...
A bientôt,
mark
On 3/29/20 2:19 PM, Armin Rigo wrote:
Hi Mark,
Oops. We lost your pull request on https://github.com/pypy/pypy-website because we killed that repo (which was never meant to be there). The real repo is at https://foss.heptapod.net/pypy/pypy.org . If you still have your changes locally, could you make a merge request on the real repo? Thank you!
A bientôt,
Armin.
-
_______________________________________________ pypy-dev mailing list pypy-dev@python.org https://mail.python.org/mailman/listinfo/pypy-dev
-- -- Dr. mark doerr Working group: Prof. Uwe T. Bornscheuer Institute of Biochemistry Dept. of Biotechnology & Enzyme Catalysis University of Greifswald Felix-Hausdorff-Str. 4 D-17487 Greifswald germany Phone: +49 (0)3834-420-4411 +49 (0)3834-420-4391 (Secr.) Fax: +49 (0)3834-420-794367 Room: B021 and B047 Web: http://lara.uni-greifswald.de/
I see, Matti, thanks for explaining the decision. These are valid arguments using nikola (the blog post part I was not aware of). Using the CI of heptapod might be really worth to have a closer look into (that also might reduce errors, since everything relies only on one service rather than two or more ). Since the core (text) information is kept in reStructured text files that are somehow rendered, it is not really important, which engine finally does it (and if in the future another engine is better suited, it will be not too difficult to switch).... Then I will make a suggestion for the README as a new topic branch and create a merge request (very likely tomorrow evening). With best regards, mark On 3/30/20 12:34 PM, Matti Picus wrote:
Those pages do look nice, and are very similar to doc.python.org or doc.pypy.org (but with a nicer theme). However this repo renders www.pypy.org, which is parallel to www.python.org, which is the "non-developer front page" of pypy and python.
Your pages are hosted as gitlab pages, which heptapod does not currently support. This repo's pages are hosted on python infrastructure via a cron script that pulls the repo from heptapod every 15 minutes.
I thought about using sphinx instead of nikola, but
- it was easier to get the theme to nikola up and running
- the theme supports mobile better than the rtd one
- nikola has some hooks for blog posts. We would like to import the morepypy.blogspot.com/ pages and self-host them here rather than on blogspot.
- nikola is actually a bit lighter than sphinx, but that is not really a criteria for selecting it as the render is almost instantaneous
We could do the build of the docs on CI, the CI runners for heptapod are quite new. Maybe worth looking into doing the "python -mpip install nikola==8.0.3 jinja2 aiohttp watchdog" and "nikola buld" in CI, but that would require rethinking the hosting process.
Of course, this is all very ad-hoc, we don't have a community of documentation contributors, so nothing is final and contributions are very welcome.
Matti
On 30/3/20 11:41 am, mark doerr wrote:
You're welcome, Matti, thanks for you fast reply. I will make a proposal for an update. Just one question/comment, since you are at the very beginning of your new repository: On our SiLA python repository ( https://gitlab.com/SiLA2/sila_python ) we are just using sphinx to generate the gitLAB static html pages: https://sila2.gitlab.io/sila_python/ With the python_docs_theme they have exactly the same look as the python.org pages. CI/CD pipeline generation is as simple as (see https://gitlab.com/SiLA2/sila_python/-/blob/master/.gitlab-ci.yml ) : pages: script: - pip install sphinx sphinx-rtd-theme python_docs_theme - cd docs ; make html - mv _build/html/ ../public/ artifacts: paths: - public only: - master
That's it. No extra tools, no extra dependency, just python standard documentation tools everyone uses anyway and the final result is very nice and close to what people see from python.org. It is also very easy to include the pypy source code documentation with autodoc in the html generation.
I do not know, if that was considered, if not, it might be worth considering before doing the final move to nikola.
With best regards, mark
On 3/30/20 10:10 AM, Matti Picus wrote:
On 29/3/20 11:43 pm, mark doerr wrote:
Hello pypy.org webmasters,
while discussing with Armin Rigo the update of the documentation of sandbox-2 on pypy.org, I realised,
that the README (in the root dir of the pypy.org repo) is still pointing to the old yatiblog pages (source/README - which contains the old yatiblog instructions).
Is someone taking care of updating the instructions to the new Nikola system (and removing the yatiblog source folder) ?
Otherwise I could offer to do a new merge request with the changes.
With kind regards,
mark
Yes thanks, that would be great. The README-DO-NOT-EDIT should be merged into the README and adjusted, and all directions should point to running "make" in the top level directory. "make help" could also be improved with a bit more verbosity. There may also be some stray files around that can be deleted.
Matti
-------- Forwarded Message -------- Subject: Re: pypy-sandbox-2 - documentation fix. Branch uploaded Date: Sun, 29 Mar 2020 18:41:52 +0200 From: mark doerr <mark.doerr@uni-greifswald.de> Organization: University Greifswald To: Armin Rigo <arigo@tunes.org>
Hi Armin,
on a second look, I realised, that pypy moved from yatiblog to nikola.
Is that true ? Then the README.rst in root is wrong: it still points to source/README (which is the old yatiblog pages and gives yatiblog instructions).
Are the pages in the "pages" folder be used currently by your system (I guess that nikola takes the pages from "pages" to build the static html) ?
Maybe the main README should also be updated ? Is someone taking care of this ?
With kind regards,
mark
On 3/29/20 6:09 PM, mark doerr wrote:
Hi Armin,
I wondering, why you had two different repos, one and github and one on foss.
It is good that you bundled the development on one site.
It is not a big problem, that you deleted my files, I still have them as a local copy.
I will add the changes to the repo on foss.heptapod tonight (I just realised, that the pypy people use yatiblog - it seems that it converts reStructured text into static html, which is nice.)
In my old commit, I changed the generated html code directly, which was not nice ;)
I will send you a note, when changes are in ...
A bientôt,
mark
On 3/29/20 2:19 PM, Armin Rigo wrote:
Hi Mark,
Oops. We lost your pull request on https://github.com/pypy/pypy-website because we killed that repo (which was never meant to be there). The real repo is at https://foss.heptapod.net/pypy/pypy.org . If you still have your changes locally, could you make a merge request on the real repo? Thank you!
A bientôt,
Armin.
-
_______________________________________________ pypy-dev mailing list pypy-dev@python.org https://mail.python.org/mailman/listinfo/pypy-dev
-- --
Dr. mark doerr Working group: Prof. Uwe T. Bornscheuer Institute of Biochemistry Dept. of Biotechnology & Enzyme Catalysis University of Greifswald Felix-Hausdorff-Str. 4 D-17487 Greifswald germany
Phone: +49 (0)3834-420-4411 +49 (0)3834-420-4391 (Secr.) Fax: +49 (0)3834-420-794367
Room: B021 and B047
-- -- Dr. mark doerr Working group: Prof. Uwe T. Bornscheuer Institute of Biochemistry Dept. of Biotechnology & Enzyme Catalysis University of Greifswald Felix-Hausdorff-Str. 4 D-17487 Greifswald germany Phone: +49 (0)3834-420-4411 +49 (0)3834-420-4391 (Secr.) Fax: +49 (0)3834-420-794367 Room: B021 and B047 Web: http://lara.uni-greifswald.de/
participants (2)
-
mark doerr -
Matti Picus