sphinx-doc-generator Namespace Reference

Functions
def	generate_rst_sphinx_files
def	collect_python_modules
def	main

Variables
string	_javascript_name_ = 'summary.js'
string	_template_
string	_javascript_template_

Function Documentation

def sphinx-doc-generator.collect_python_modules	(		root_dir,
			name = None
	)

References ObjexxFCL.len().

Referenced by main().

def sphinx-doc-generator.generate_rst_sphinx_files	(		modules,
			output_dir,
			javascript_path
	)

References fmt.join(), ObjexxFCL.len(), and basic::database.open().

Referenced by main().

def sphinx-doc-generator.main

(

args

)

Binding demo build/test script 

References collect_python_modules(), pyrosetta.tests.distributed.test_dask.format, generate_rst_sphinx_files(), basic::database.open(), fmt.print(), and binder.split().

Variable Documentation

string sphinx-doc-generator._javascript_name_ = 'summary.js'

string sphinx-doc-generator._javascript_template_

string sphinx-doc-generator._template_

Initial value:

= '''
{name}
{name_underline}

.. toctree::
    :maxdepth: 1

    {sub_modules}

.. container:: cfv-summary

    .. raw:: html

        <script type="text/javascript" src='{javascript_path}/{_javascript_name_}'></script>


.. automodule:: {module}
    :members:
    :undoc-members:
    :show-inheritance:
    :private-members:
    :inherited-members:

..    :special-members:

'''