You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "kojiromike (via GitHub)" <gi...@apache.org> on 2023/07/21 19:15:03 UTC

[GitHub] [avro] kojiromike opened a new pull request, #2380: AVRO-312 Python Sphinx Documentation

kojiromike opened a new pull request, #2380:
URL: https://github.com/apache/avro/pull/2380

   AVRO-312 Python Sphinx Documentation
   
   This is a backport of #2370, to 1.11.0.
   
   Generate Documentation in docs/build/*.html when ./build.sh docs is run.
   
   Implementation detail: Uses tox to install build-time dependencies.
   
   * Add Tox to Python Build Requirements
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [avro] kojiromike commented on a diff in pull request #2380: AVRO-312 Python Sphinx Documentation

Posted by "kojiromike (via GitHub)" <gi...@apache.org>.
kojiromike commented on code in PR #2380:
URL: https://github.com/apache/avro/pull/2380#discussion_r1271169466


##########
lang/py/build.sh:
##########
@@ -51,6 +51,14 @@ dist() (
   "$virtualenv/bin/python3" -m build --outdir "$destination"
 )
 
+doc() {
+  local doc_dir
+  [[ -s VERSION.txt ]] || cp ../../share/VERSION.txt .
+  doc_dir="../../build/avro-doc-$(<VERSION.txt)/api/py"
+  python3 -m tox -e docs

Review Comment:
   ```suggestion
     mkdir -p "$doc_dir"
     python3 -m tox -e docs
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [avro] kojiromike merged pull request #2380: AVRO-312: Python Sphinx Documentation

Posted by "kojiromike (via GitHub)" <gi...@apache.org>.
kojiromike merged PR #2380:
URL: https://github.com/apache/avro/pull/2380


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@avro.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org