Skip to content

Files

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Step to create documentation

sphinx-build <file_path_which_has_conf.py_and_index.rst>  <path_to_store_docs>

# start server to check file
python -m http.server 5000

# navigate to <path_to_store_docs>

Sample of docstring

    """
    This is example.

    Args:
        input_dir: ``str``
            dir where protobuf are stored
        output_dir ``str``
            directory where model will be saved too
        list_lis: ``list``
            test value.

            .. code-block:: json
            
                {"this_example": "hello",
                ....}

    Returns:
        None
    """

More detail

sphnix_example
sphinx_website