fqr.docs package

Overview

Summary: fqr extension for generating wiki documentation with Sphinx.

Usage

Document a package as follows.

$ pip install fqr[docs]
$ fqr docs package_name

Subpackages

• fqr.docs.static package

Submodules

• fqr.docs.cfg module
  • Constants
    • Constants.BASE_VERSION
    • Constants.DOCS_STATIC_DIR
    • Constants.DEFAULT_USER
• fqr.docs.enm module
  • NoCrawlPath
    • NoCrawlPath.search
    • NoCrawlPath.api
    • NoCrawlPath.builds
  • SiteMapChangeFreq
    • SiteMapChangeFreq.daily
    • SiteMapChangeFreq.weekly
    • SiteMapChangeFreq.monthly
  • SupportedTheme
    • SupportedTheme.agogo
    • SupportedTheme.alabaster
    • SupportedTheme.bizstyle
    • SupportedTheme.classic
    • SupportedTheme.haiku
    • SupportedTheme.nature
    • SupportedTheme.pyramid
    • SupportedTheme.scrolls
    • SupportedTheme.sphinxdoc
    • SupportedTheme.traditional
  • Boolean
    • Boolean.true
    • Boolean.false
  • NoneAlias
    • NoneAlias.null
    • NoneAlias.none
    • NoneAlias.nan
• fqr.docs.lib module
  • TypeVarTuple
• fqr.docs.obj module
  • Pattern
    • Pattern.ModulePattern
    • Pattern.MinOneWordPattern
    • Pattern.PathPattern
    • Pattern.PrefixPattern
• fqr.docs.utl module
  • document()