ptupitsyn commented on code in PR #4561: URL: https://github.com/apache/ignite-3/pull/4561#discussion_r1800538716
########## modules/platforms/python/README.md: ########## @@ -46,3 +46,20 @@ Running tests themselves: ```bash $ pytest ``` + +## Documentation + +Do not forget to install documentation requirements: +```bash +$ pip install -r requirements/docs.txt +``` + +After this, you can generate documentation using following commands: Review Comment: ```suggestion Generate documentation: ``` I think shorter is better here. ########## modules/platforms/python/README.md: ########## @@ -46,3 +46,20 @@ Running tests themselves: ```bash $ pytest ``` + +## Documentation + +Do not forget to install documentation requirements: Review Comment: ```suggestion Install documentation requirements: ``` ########## modules/platforms/python/docs/conf.py: ########## @@ -0,0 +1,68 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +import os +import sys + +sys.path.insert(0, os.path.abspath('../')) + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'pyignite3' +copyright = '2024, The Apache Software Foundation' +author = 'The Apache Software Foundation' +release = '3.1' Review Comment: Is this the Ignite version? Should we update the release procedure to bump this number? -- 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: notifications-unsubscr...@ignite.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
