Skip to content

Automate openfhe-python document generation for readthedocs.org and resolve/supress warnings #217

@dsuponitskiy

Description

@dsuponitskiy

:~/git/openfhe-python/docs$ make html
Running Sphinx v8.1.3
loading translations [en]... done
making output directory... done
Converting source_suffix = '.rst' to source_suffix = {'.rst': 'restructuredtext'}.
loading pickled environment... The configuration has changed (3 options: 'html_permalinks_icon', 'html_static_path', 'jquery_use_sri')
done
[autosummary] generating autosummary for: binfhe.rst, binfhe_enums.rst, ciphertext.rst, cryptocontext.rst, cryptoparams.rst, index.rst, keys.rst, pke_enums.rst, plaintext.rst
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 9 source files that are out of date
updating environment: 0 added, 8 changed, 0 removed
reading sources... [100%] plaintext
docstring of openfhe.PyCapsule.EvalFHEWtoCKKSSetup:5: WARNING: Field list ends without a blank line; unexpected unindent. [docutils]
docstring of openfhe.PyCapsule.InsertEvalAutomorphismKey:4: WARNING: Field list ends without a blank line; unexpected unindent. [docutils]
docstring of openfhe.PyCapsule.MakeCoefPackedPlaintext:5: WARNING: Field list ends without a blank line; unexpected unindent. [docutils]
~/git/openfhe-python/docs/docstring of openfhe.PyCapsule.MultiAddEvalAutomorphismKeys:1: WARNING: could not parse arglist ("self: openfhe.CryptoContext, evalKeyMap1: openfhe.EvalKeyMap, evalKeyMap1: openfhe.EvalKeyMap, keyTag: str = ''"): duplicate parameter name: 'evalKeyMap1'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets...
copying static files...
Writing evaluated template result to ~/git/openfhe-python/docs/html/_static/basic.css
Writing evaluated template result to ~/git/openfhe-python/docs/html/_static/language_data.js
Writing evaluated template result to ~/git/openfhe-python/docs/html/_static/documentation_options.js
Writing evaluated template result to ~/git/openfhe-python/docs/html/_static/js/versions.js
copying static files: done
copying extra files...
copying extra files: done
copying assets: done
writing output... [100%] plaintext
generating indices... genindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 4 warnings.

The HTML pages are in html.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions