)]}'
{"reference/project-testing-interface.rst":[{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"36ccde661b847dc5367ec5fac5d5e7bb185c559c","unresolved":false,"context_lines":[{"line_number":84,"context_line":"   Additional logic needed around Sphinx generation should go into"},{"line_number":85,"context_line":"   Sphinx plugins."},{"line_number":86,"context_line":""},{"line_number":87,"context_line":"To support PDF documentation generation, the projects should use"},{"line_number":88,"context_line":"PDF build support Sphinx plugins and the following command should work"},{"line_number":89,"context_line":"with ``xelatex`` environment and should result in a PDF file in"},{"line_number":90,"context_line":"``doc/build/pdf``."},{"line_number":91,"context_line":""},{"line_number":92,"context_line":".. code-block:: bash"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_c35b1521","line":89,"range":{"start_line":87,"start_character":0,"end_line":89,"end_character":28},"updated":"2018-08-02 22:23:20.000000000","message":"To support generating PDF documentation, the projects should use\nSphinx plugins for PDF build support and the following command should work\nwith ``xelatex`` environment","commit_id":"4e2603bc5149144709cd5fdcf5452c25ef669d6d"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"12d104601ce24fb35934f3f4ea44d0a1c33a5fb5","unresolved":false,"context_lines":[{"line_number":84,"context_line":"   Additional logic needed around Sphinx generation should go into"},{"line_number":85,"context_line":"   Sphinx plugins."},{"line_number":86,"context_line":""},{"line_number":87,"context_line":"To support PDF documentation generation, the projects should use"},{"line_number":88,"context_line":"PDF build support Sphinx plugins and the following command should work"},{"line_number":89,"context_line":"with ``xelatex`` environment and should result in a PDF file in"},{"line_number":90,"context_line":"``doc/build/pdf``."},{"line_number":91,"context_line":""},{"line_number":92,"context_line":".. code-block:: bash"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_625f9110","line":89,"range":{"start_line":87,"start_character":0,"end_line":89,"end_character":28},"in_reply_to":"5f7c97a3_c35b1521","updated":"2018-08-03 11:23:43.000000000","message":"Done","commit_id":"4e2603bc5149144709cd5fdcf5452c25ef669d6d"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"1672d003b41075422598c41e022d5384f0ec616b","unresolved":false,"context_lines":[{"line_number":91,"context_line":""},{"line_number":92,"context_line":".. code-block:: bash"},{"line_number":93,"context_line":""},{"line_number":94,"context_line":"  sphinx-build -b latex doc/source doc/build/pdf"},{"line_number":95,"context_line":"  make -C doc/build/pdf"},{"line_number":96,"context_line":""},{"line_number":97,"context_line":"Language specific instructions supplement these and are in addition to"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_1bdf430c","line":94,"updated":"2018-08-02 14:59:37.000000000","message":"You should include the -W flag here too","commit_id":"4e2603bc5149144709cd5fdcf5452c25ef669d6d"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"643b10cf85a66094d8100f8cb4a29ab180564f23","unresolved":false,"context_lines":[{"line_number":91,"context_line":""},{"line_number":92,"context_line":".. code-block:: bash"},{"line_number":93,"context_line":""},{"line_number":94,"context_line":"  sphinx-build -b latex doc/source doc/build/pdf"},{"line_number":95,"context_line":"  make -C doc/build/pdf"},{"line_number":96,"context_line":""},{"line_number":97,"context_line":"Language specific instructions supplement these and are in addition to"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_e2fc010d","line":94,"in_reply_to":"5f7c97a3_1bdf430c","updated":"2018-08-03 11:23:21.000000000","message":"I agree with u - done!","commit_id":"4e2603bc5149144709cd5fdcf5452c25ef669d6d"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"1672d003b41075422598c41e022d5384f0ec616b","unresolved":false,"context_lines":[{"line_number":93,"context_line":""},{"line_number":94,"context_line":"  sphinx-build -b latex doc/source doc/build/pdf"},{"line_number":95,"context_line":"  make -C doc/build/pdf"},{"line_number":96,"context_line":""},{"line_number":97,"context_line":"Language specific instructions supplement these and are in addition to"},{"line_number":98,"context_line":"them."},{"line_number":99,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_dbf1cb99","line":96,"updated":"2018-08-02 14:59:37.000000000","message":"I wonder if we need to mention the need to install binary dependencies? In most cases, you can use openstackdocstheme for this, like so:\n\n  $ git clone https://github.com/openstack/openstackdocstheme\n  $ tox -e bindep\n\nThough maybe that\u0027s too much detail? Your call","commit_id":"4e2603bc5149144709cd5fdcf5452c25ef669d6d"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"643b10cf85a66094d8100f8cb4a29ab180564f23","unresolved":false,"context_lines":[{"line_number":93,"context_line":""},{"line_number":94,"context_line":"  sphinx-build -b latex doc/source doc/build/pdf"},{"line_number":95,"context_line":"  make -C doc/build/pdf"},{"line_number":96,"context_line":""},{"line_number":97,"context_line":"Language specific instructions supplement these and are in addition to"},{"line_number":98,"context_line":"them."},{"line_number":99,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_e225e1ae","line":96,"in_reply_to":"5f7c97a3_dbf1cb99","updated":"2018-08-03 11:23:21.000000000","message":"I did not mention them because the upper part [1] covers the same thing with different sentences.\n\n[1] https://git.openstack.org/cgit/openstack/governance/tree/reference/project-testing-interface.rst#n54","commit_id":"4e2603bc5149144709cd5fdcf5452c25ef669d6d"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"8daae4b7d853e4af84a1df851e8272569b5d32a4","unresolved":false,"context_lines":[{"line_number":59,"context_line":"* Have a ``docs`` environment set up in a ``tox.ini`` file within the"},{"line_number":60,"context_line":"  repository."},{"line_number":61,"context_line":""},{"line_number":62,"context_line":"Additionally, projects can have a ``publishdocs`` environment set up"},{"line_number":63,"context_line":"in a ``tox.ini`` file to include the same command in ``docs`` environment"},{"line_number":64,"context_line":"and more commands for translated documents and PDF generation."},{"line_number":65,"context_line":""},{"line_number":66,"context_line":"Assuming non-Python requirements have been properly installed as"},{"line_number":67,"context_line":"indicated by ``bindep.txt``, the following command should work with no"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3f79a3b5_c2542c24","line":64,"range":{"start_line":62,"start_character":0,"end_line":64,"end_character":62},"updated":"2018-08-08 16:20:51.000000000","message":"Projects shouldn\u0027t need that in general, openstack-manuals is special here. Let\u0027s remove the paragraph.","commit_id":"dad4b5fe557ae503a3c3c129a19397bdf7f0abb1"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"b7303f150fc4b33622d67c1b30b8fd14cb52aebb","unresolved":false,"context_lines":[{"line_number":91,"context_line":""},{"line_number":92,"context_line":".. code-block:: bash"},{"line_number":93,"context_line":""},{"line_number":94,"context_line":"  sphinx-build -W -b latex doc/source doc/build/pdf"},{"line_number":95,"context_line":"  make -C doc/build/pdf"},{"line_number":96,"context_line":""},{"line_number":97,"context_line":"Language specific instructions supplement these and are in addition to"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5f7c97a3_0597c748","line":94,"updated":"2018-08-03 12:51:11.000000000","message":"Should these 2 commands be part of the publishdocs environment? If so, maybe that environment should be called something more descriptive, like docspdf? And we should call out that command as we do for the HTML build up on line 73.","commit_id":"dad4b5fe557ae503a3c3c129a19397bdf7f0abb1"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"8fe13517e62e92966f5af4a7c9021e4e1e19dd58","unresolved":false,"context_lines":[{"line_number":91,"context_line":""},{"line_number":92,"context_line":".. code-block:: bash"},{"line_number":93,"context_line":""},{"line_number":94,"context_line":"  sphinx-build -W -b latex doc/source doc/build/pdf"},{"line_number":95,"context_line":"  make -C doc/build/pdf"},{"line_number":96,"context_line":""},{"line_number":97,"context_line":"Language specific instructions supplement these and are in addition to"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3f79a3b5_3d9c215c","line":94,"in_reply_to":"3f79a3b5_2214004e","updated":"2018-08-08 16:58:57.000000000","message":"I would definitely like to see what changes would be needed in a tox.ini or sphinx config.py file to make a single job work for all of these purposes.","commit_id":"dad4b5fe557ae503a3c3c129a19397bdf7f0abb1"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"8daae4b7d853e4af84a1df851e8272569b5d32a4","unresolved":false,"context_lines":[{"line_number":91,"context_line":""},{"line_number":92,"context_line":".. code-block:: bash"},{"line_number":93,"context_line":""},{"line_number":94,"context_line":"  sphinx-build -W -b latex doc/source doc/build/pdf"},{"line_number":95,"context_line":"  make -C doc/build/pdf"},{"line_number":96,"context_line":""},{"line_number":97,"context_line":"Language specific instructions supplement these and are in addition to"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3f79a3b5_2214004e","line":94,"in_reply_to":"3f79a3b5_79c5ed3b","updated":"2018-08-08 16:20:51.000000000","message":"4 different jobs is far too much.\n\nI think most projects can use a *single* job that does all of the above. Let\u0027s document that first.\n\nExceptions - like 4 jobs - can be then worked on separately.","commit_id":"dad4b5fe557ae503a3c3c129a19397bdf7f0abb1"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"423f74b61a27f69b933b818d1e749b2b91b970bc","unresolved":false,"context_lines":[{"line_number":91,"context_line":""},{"line_number":92,"context_line":".. code-block:: bash"},{"line_number":93,"context_line":""},{"line_number":94,"context_line":"  sphinx-build -W -b latex doc/source doc/build/pdf"},{"line_number":95,"context_line":"  make -C doc/build/pdf"},{"line_number":96,"context_line":""},{"line_number":97,"context_line":"Language specific instructions supplement these and are in addition to"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5f7c97a3_40a7ed0b","line":94,"in_reply_to":"5f7c97a3_0597c748","updated":"2018-08-03 13:15:52.000000000","message":"Yes and I have thought about executing like \u0027tox -e publishdocs` to further consider to additionally specify how to publish translated documents for the publication of https://review.openstack.org/#/c/572559/ .\n\nBefore more specifying with tox environment, I wanna ask: would it be fine with using \u0027tox -e publishdocs\u0027 naming? I agree with the naming of \u0027docspdf\u0027 when I just consider pdf publication but when I also consider the publication of translated docs then I have thought that \u0027publishdocs\u0027 naming would be better to include both pdf and translated docs. Or having two names like \u0027docspdf\u0027 and \u0027docsi18n\u0027 would be an alternative idea but I think specifying more environment would not be a good idea.","commit_id":"dad4b5fe557ae503a3c3c129a19397bdf7f0abb1"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"14a5bd6ff4835b3091b39524f93f7abf8eb14d28","unresolved":false,"context_lines":[{"line_number":91,"context_line":""},{"line_number":92,"context_line":".. code-block:: bash"},{"line_number":93,"context_line":""},{"line_number":94,"context_line":"  sphinx-build -W -b latex doc/source doc/build/pdf"},{"line_number":95,"context_line":"  make -C doc/build/pdf"},{"line_number":96,"context_line":""},{"line_number":97,"context_line":"Language specific instructions supplement these and are in addition to"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3f79a3b5_79c5ed3b","line":94,"in_reply_to":"5f7c97a3_369b1b66","updated":"2018-08-07 14:34:58.000000000","message":"For translations, just HTML right now. For translated PDF, it can be supported in future but I would like to first address the implementation of this patch and https://review.openstack.org/#/c/572559/ and then I would like to support translated PDF builds.\n\nIMO there would four different jobs:\n- \"docs\": build html docs\n- build pdf docs\n- build translated html docs\n- build translated pdf docs (in future).\n\nI thought that \"docs\" is mandatory for official projects, and others would be described as one optional job \"publishdocs\" to support additional docs build. Maybe changing this name to \"additionaldocs\" or \"optionaldocs\" would be a better idea?","commit_id":"dad4b5fe557ae503a3c3c129a19397bdf7f0abb1"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"5f8b8f05f503fd06e09d2ee524257a1898eb9ee9","unresolved":false,"context_lines":[{"line_number":91,"context_line":""},{"line_number":92,"context_line":".. code-block:: bash"},{"line_number":93,"context_line":""},{"line_number":94,"context_line":"  sphinx-build -W -b latex doc/source doc/build/pdf"},{"line_number":95,"context_line":"  make -C doc/build/pdf"},{"line_number":96,"context_line":""},{"line_number":97,"context_line":"Language specific instructions supplement these and are in addition to"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5f7c97a3_369b1b66","line":94,"in_reply_to":"5f7c97a3_40a7ed0b","updated":"2018-08-03 14:55:53.000000000","message":"I am concerned that \"publishdocs\" is going to be confusing because we do publish out of the \"docs\" environment build now. Do we publish the translations as HTML, or only as PDF?","commit_id":"dad4b5fe557ae503a3c3c129a19397bdf7f0abb1"}]}