module sphinxext.sphinx_mlext

Inheritance diagram of csharpyml.sphinxext.sphinx_mlext

Short summary

module csharpyml.sphinxext.sphinx_mlext

Extends Sphinx to easily write documentation with ML.net.

source on GitHub

Classes

class truncated documentation
MlCmdDirective Runs a command line based on ML.net.
RunCSharpMLDirective Implicits “and dependencies.

Functions

function truncated documentation
builds_components_pages Returns components pages.
maml_pythonnet Runs a maml script through ML.net.
maml_test Tests the assembly.
mlnet_components_kinds Retrieves all kinds.
setup Adds the custom directive.
write_components_pages Writes documentation pages.

Methods

method truncated documentation
modify_script_before_running The methods modifies self.content.
modify_script_before_running The methods modifies the script to csharpy to run C# from Python.

Documentation

Extends Sphinx to easily write documentation with ML.net.

source on GitHub

class csharpyml.sphinxext.sphinx_mlext.MlCmdDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]

Bases: pyquickhelper.sphinxext.sphinx_runpython_extension.RunPythonDirective

Runs a command line based on ML.net.

source on GitHub

modify_script_before_running(script)[source]

The methods modifies self.content.

source on GitHub

class csharpyml.sphinxext.sphinx_mlext.RunCSharpMLDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]

Bases: csharpy.sphinxext.sphinx_runcsharp_extension.RunCSharpDirective

Implicits “and dependencies.

source on GitHub

modify_script_before_running(script)[source]

The methods modifies the script to csharpy to run C# from Python.

source on GitHub

csharpyml.sphinxext.sphinx_mlext.builds_components_pages(epkg)[source]

Returns components pages.

Parameters:epkg – dictionary used to replace substrings by hyperlinks
Returns:list of modified pages

source on GitHub

csharpyml.sphinxext.sphinx_mlext.maml_pythonnet(script, verbose=2)[source]

Runs a maml script through ML.net.

Parameters:
  • script – script
  • verbose – adjust the verbosity
Returns:

stdout and stderr

source on GitHub

csharpyml.sphinxext.sphinx_mlext.maml_test()[source]

Tests the assembly.

source on GitHub

csharpyml.sphinxext.sphinx_mlext.mlnet_components_kinds()[source]

Retrieves all kinds.

source on GitHub

csharpyml.sphinxext.sphinx_mlext.setup(app)[source]

Adds the custom directive.

source on GitHub

csharpyml.sphinxext.sphinx_mlext.write_components_pages(app, env, docnames)[source]

Writes documentation pages.

source on GitHub