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:
-
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:
-- -- 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:
-- -- 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/
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:
-- -- 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:
-- -- 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