You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by "LuigiCerone (via GitHub)" <gi...@apache.org> on 2023/03/14 19:59:55 UTC
[GitHub] [iceberg] LuigiCerone opened a new pull request, #7108: Add mkdocstrings
LuigiCerone opened a new pull request, #7108:
URL: https://github.com/apache/iceberg/pull/7108
Closes #7100.
--
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@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
[GitHub] [iceberg] Fokko commented on pull request #7108: Add mkdocstrings
Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko commented on PR #7108:
URL: https://github.com/apache/iceberg/pull/7108#issuecomment-1468965350
@LuigiCerone what do you think? It feels a bit whacky on my end. Some pages are empty (for example Manifest), and all the menus are expanded which doesn't give a lot of useful information (I don't really care about the zstd decompression of Avro, and the page is also empty).
--
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@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
[GitHub] [iceberg] Fokko commented on a diff in pull request #7108: Add mkdocstrings
Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko commented on code in PR #7108:
URL: https://github.com/apache/iceberg/pull/7108#discussion_r1136309725
##########
python/mkdocs/requirements.txt:
##########
@@ -17,3 +17,6 @@
mkdocs==1.4.2
jinja2==3.1.2
+mkdocstrings==0.20.0
+mkdocstrings-python==0.8.3
+mkdocs-literate-nav==0.6.0
Review Comment:
I had to install `mkdocs-gen-files==0.4.0` as well.
--
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@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
[GitHub] [iceberg] Fokko merged pull request #7108: Add mkdocstrings
Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko merged PR #7108:
URL: https://github.com/apache/iceberg/pull/7108
--
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@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
[GitHub] [iceberg] Fokko commented on pull request #7108: Add mkdocstrings
Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko commented on PR #7108:
URL: https://github.com/apache/iceberg/pull/7108#issuecomment-1488860601
> Continue to use the gen-files plugin to generate documentation pages automatically, but exclude Python files without docstrings or ones that are not significant (such as zstd, which you mentioned).
has my strong preference, doing it manually is not a scalable solution :)
--
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@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
[GitHub] [iceberg] LuigiCerone commented on pull request #7108: Add mkdocstrings
Posted by "LuigiCerone (via GitHub)" <gi...@apache.org>.
LuigiCerone commented on PR #7108:
URL: https://github.com/apache/iceberg/pull/7108#issuecomment-1470417548
Hello @Fokko , I agree with you.
The reason for the blank pages is that there are no docstrings for the methods in the relevant Python file. There are two options that come to mind:
* Continue to use the gen-files plugin to generate documentation pages automatically, but exclude Python files without docstrings or ones that are not significant (such as zstd, which you mentioned).
* Remove the gen-files plugin and its automatic generation script and manually add only the most important and central modules/classes for the pyiceberg project.
Regarding the problem of the menu expanding, I have also noticed this issue. It appears to be caused by the gen-files plugin and the way in which I've configured it. I will investigate further, taking into account the decision we made in the previous point.
Let me know what do you think :)
--
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@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org