Description

This page shows how a website looks like if this code is added to the <head>:

<link
    rel="stylesheet"
    href="https://sourceforge.net/p/whakerexa/code/ci/master/tree/statics/css/wexa.css?format=raw"
    media="all" />
<link
    rel="stylesheet"
    href="https://sourceforge.net/p/whakerexa/code/ci/master/tree/statics/css/menu.css?format=raw"
    media="all" />

Overview

wexa.css is a CSS framework intended to be as simple as possible to make accessible web content, and to minimize the use of CSS classes for enhancing the readability of HTML code, like it should always be! wexa.css is the main CSS framework of Whakerexa.

Pygments is a generic syntax highlighter suitable for use in code hosting, forums, wikis or other applications that need to prettify source code.

code.css is a custom colors definition for Python code.

Examples

The following examples were automatically generated with ClammingPy 1.7.

def markdown(self) -> str:
    """Return the documentation of the package as a standalone Markdown content."""
  md = list()
  md.append('## Package `{:s}`\n'.format(self.__name))
  for clams in self.__clams:
      md.append(clams.markdown())
  md.append('\n\n~ Created using [Clamming](https://clamming.sf.net) version {:s} ~\n'.format(clamming.__version__))
  return '\n'.join(md)

Show/Hide source code into a details/summary element

                def __init__(self, parsed_obj: ClammingClassParser):
    """Create documentation from the given parsed class object.

    HTML conversion depends on external libraries. It could be disabled
    if any of them is missing. If not, customizing the HTML export can
    be done by assigning different values to members or by changing their
    optional parameters.

    See `Pygments` documentation:
    [HtmlFormatter](https://pygments.org/docs/formatters/#HtmlFormatter)
    and
    [Lexer](https://pygments.org/docs/lexers/#pygments.lexers.python.PythonLexer)

    :example:
    >>> self.markdowner = markdown2.Markdown()
    >>> self.formatter = pygments_formatter.HtmlFormatter(**ClamsClass.HTML_FORMATTER_ARGS)
    >>> self.lexer = pygments_lexers.PythonLexer()

    :param parsed_obj: A parsed object.

    """
  self.markdowner = None
  self.lexer = None
  self.formatter = None
  self.__set_html_members()
  self.__info_class_name = parsed_obj.obj_clams.name
  self.__info_class_description = parsed_obj.obj_clams
  self.__info_constructor = parsed_obj.init_clams
  self.__info_public_fcts = list()
  for fct_name in parsed_obj.fct_clams:
      if fct_name.startswith('_') is False:
          self.__info_public_fcts.append(parsed_obj.fct_clams[fct_name])
  self.__info_private_fcts = list()
  for fct_name in parsed_obj.fct_clams:
      if fct_name.startswith('_') is True and fct_name.startswith('__') is False:
          self.__info_private_fcts.append(parsed_obj.fct_clams[fct_name])
  self.__info_protected_fcts = list()
  for fct_name in parsed_obj.fct_clams:
      if fct_name.startswith('__') is True and fct_name.endswith('__') is False:
          self.__info_protected_fcts.append(parsed_obj.fct_clams[fct_name])
  self.__info_overloads = list()
  for fct_name in parsed_obj.fct_clams:
      if fct_name.startswith('__') is True and fct_name.endswith('__') is True:
          self.__info_overloads.append(parsed_obj.fct_clams[fct_name])