Category : autodoc

I am trying to install Autodoc FR (ADFR), on MacOS BIG SUR, but everytime I am getting popup window sayin "Python 2.7 cant be opened because the developer cannot be varified, even I allowe for sequrity and privacy, however again saing same popup my comand line is [email protected] ADFRsuite_x86_64Darwin_1.0 % ./install.sh -d /Users/mdumar/Desktop/docking -c 0 ..

Read more

Is it possible to set the Sphinx autodoc Python module path from Jupyter Book, for example via _config.yml? I’m using Jupyter Book to document a Python system and publish to Read The Docs. I can set the module path from Sphinx by adding code like this to conf.py: import os import sys sys.path.insert(0, os.path.abspath("my/module/path")) However, ..

Read more

I have tried .. autoclass:: ChatCommandHandler() with no luck to remove the signature, is this possible with an extension to make a custom option like :exclude-signature or something. my extensions: extensions = [ ‘sphinx.ext.napoleon’, ‘sphinx.ext.autodoc’, ‘sphinx.ext.intersphinx’, ‘exception_hierarchy’, ‘attributetable’, ‘silence’, ‘sphinx_autodoc_typehints’ ] first 3 are ext’s from sphinx, attributetable is a custom ext for a table ..

Read more

For module level functions, is there a way to auto generate content that frequently appears, namely ‘Returns: None’ , so that it wouldn’t be repeatedly written in many docstrings? I’ve seen some formatting using napoleon_custom_sections, but that doesn’t seem to be my direct use case. Example would be if the following generated documentation that contained ..

Read more

I have the following structure: └──faulty_meter └── __init__.py └── run.py └── utils.py └── anomalous_kwh_detection └── __init__.py └── general_anomalies.py └── slowing_down.py └── docs └── Makefile └── build └── make.bat └── source └── conf.py └── index.rst run.py imports utils.py and the files in anomalous_kwh_detection. I run sphinx as follows from docs: sphinx-quickstart sphinx-apidoc -o ./source .. make ..

Read more

I have the following classes import abc class Parent(metaclass=abc.ABCMeta): def __init__( self, username: str, password: str, log_file: Optional[str] = None, secret: Optional[str] = None, local_directory: Optional[str] = None, folder_path: Optional[str] = None, dataset: Optional[str] = None, table: Optional[str] = None, columns: Optional[list] = None ) -> None: pass class Child(Parent): def __init__( self, username: str, ..

Read more