VirusTotal / vt-py

The official Python 3 client library for VirusTotal
https://virustotal.github.io/vt-py/
Apache License 2.0
547 stars 127 forks source link

docs(api): Generate API reference docs #144

Closed mgmacias95 closed 1 year ago

mgmacias95 commented 1 year ago

Generated using


$ cd docs/
$ export PYTHONPATH=$PYTHONPATH:`pwd`/..
$ make html                             
Running Sphinx v6.1.3
WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English).
WARNING: html_static_path entry '_static' does not exist
loading pickled environment... done
[autosummary] generating autosummary for: api/client.rst, api/feed.rst, api/iterator.rst, api/object.rst, api/utils.rst, apireference.rst, howtoinstall.rst, index.rst, overview.rst, quickstart.rst
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 5 changed, 0 removed
reading sources... [100%] api/utils                                                                                                                                                                                                                                                    
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index                                                                                                                                                                                                                                                         
generating indices... genindex py-modindex done
highlighting module code... [100%] vt.object                                                                                                                                                                                                                                           
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 2 warnings.

The HTML pages are in ..```