new(doc): Added basic support for generating documentation with Sphinx

This commit is contained in:
antirotor 2019-05-13 19:06:30 +02:00
parent 4b977bcea2
commit 7a0d446c1d
No known key found for this signature in database
GPG key ID: 8A29C663C672C2B7
33 changed files with 1264 additions and 1 deletions

19
docs/Makefile Normal file
View file

@ -0,0 +1,19 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

35
docs/make.bat Normal file
View file

@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
:end
popd

222
docs/source/conf.py Normal file
View file

@ -0,0 +1,222 @@
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import sys
import os
from pprint import pprint
from pypeapp.pypeLauncher import PypeLauncher
from pypeapp.storage import Storage
from pypeapp.deployment import Deployment
pype_setup = os.getenv('PYPE_ROOT')
d = Deployment(pype_setup)
launcher = PypeLauncher()
tools, config_path = d.get_environment_data()
os.environ['PYPE_CONFIG'] = config_path
os.environ['TOOL_ENV'] = os.path.normpath(os.path.join(config_path,
'environments'))
launcher._add_modules()
Storage().update_environment()
launcher._load_default_environments(tools=tools)
# -- Project information -----------------------------------------------------
project = 'pype'
copyright = '2019, Orbi Tools'
author = 'Orbi Tools'
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = ''
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.autosummary',
'recommonmark'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'friendly'
# -- Options for autodoc -----------------------------------------------------
autodoc_default_flags = ['members']
autosummary_generate = True
# -- Options for HTML output -------------------------------------------------
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
'collapse_navigation': False
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'pypedoc'
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'pype.tex', 'pype Documentation',
'OrbiTools', 'manual'),
]
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'pype', 'pype Documentation',
[author], 1)
]
# -- Options for Texinfo output ----------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'pype', 'pype Documentation',
author, 'pype', 'One line description of project.',
'Miscellaneous'),
]
# -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''
# A unique identification for the text.
#
# epub_uid = ''
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Extension configuration -------------------------------------------------
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
# -- Options for todo extension ----------------------------------------------
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

18
docs/source/index.rst Normal file
View file

@ -0,0 +1,18 @@
.. pype documentation master file, created by
sphinx-quickstart on Mon May 13 17:18:23 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to pype's documentation!
================================
.. toctree::
readme
modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

7
docs/source/modules.rst Normal file
View file

@ -0,0 +1,7 @@
pype
====
.. toctree::
:maxdepth: 6
pype

View file

@ -0,0 +1,20 @@
pype.aport package
==================
.. automodule:: pype.aport
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.aport.api module
---------------------
.. automodule:: pype.aport.api
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,20 @@
pype.avalon\_apps package
=========================
.. automodule:: pype.avalon_apps
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.avalon\_apps.avalon\_app module
------------------------------------
.. automodule:: pype.avalon_apps.avalon_app
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,36 @@
pype.clockify package
=====================
.. automodule:: pype.clockify
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.clockify.clockify module
-----------------------------
.. automodule:: pype.clockify.clockify
:members:
:undoc-members:
:show-inheritance:
pype.clockify.clockify\_api module
----------------------------------
.. automodule:: pype.clockify.clockify_api
:members:
:undoc-members:
:show-inheritance:
pype.clockify.widget\_settings module
-------------------------------------
.. automodule:: pype.clockify.widget_settings
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,36 @@
pype.ftrack.ftrack\_server package
==================================
.. automodule:: pype.ftrack.ftrack_server
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.ftrack.ftrack\_server.event\_server module
-----------------------------------------------
.. automodule:: pype.ftrack.ftrack_server.event_server
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.ftrack\_server.event\_server\_cli module
----------------------------------------------------
.. automodule:: pype.ftrack.ftrack_server.event_server_cli
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.ftrack\_server.ftrack\_server module
------------------------------------------------
.. automodule:: pype.ftrack.ftrack_server.ftrack_server
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,52 @@
pype.ftrack.lib package
=======================
.. automodule:: pype.ftrack.lib
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.ftrack.lib.avalon\_sync module
-----------------------------------
.. automodule:: pype.ftrack.lib.avalon_sync
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.lib.ftrack\_action\_handler module
----------------------------------------------
.. automodule:: pype.ftrack.lib.ftrack_action_handler
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.lib.ftrack\_app\_handler module
-------------------------------------------
.. automodule:: pype.ftrack.lib.ftrack_app_handler
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.lib.ftrack\_base\_handler module
--------------------------------------------
.. automodule:: pype.ftrack.lib.ftrack_base_handler
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.lib.ftrack\_event\_handler module
---------------------------------------------
.. automodule:: pype.ftrack.lib.ftrack_event_handler
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,52 @@
pype.ftrack package
===================
.. automodule:: pype.ftrack
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
pype.ftrack.ftrack_server
pype.ftrack.lib
Submodules
----------
pype.ftrack.credentials module
------------------------------
.. automodule:: pype.ftrack.credentials
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.ftrack\_module module
---------------------------------
.. automodule:: pype.ftrack.ftrack_module
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.login\_dialog module
--------------------------------
.. automodule:: pype.ftrack.login_dialog
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.login\_tools module
-------------------------------
.. automodule:: pype.ftrack.login_tools
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,27 @@
pype.fusion package
===================
.. automodule:: pype.fusion
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
pype.fusion.scripts
Submodules
----------
pype.fusion.lib module
----------------------
.. automodule:: pype.fusion.lib
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,28 @@
pype.fusion.scripts package
===========================
.. automodule:: pype.fusion.scripts
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.fusion.scripts.fusion\_switch\_shot module
-----------------------------------------------
.. automodule:: pype.fusion.scripts.fusion_switch_shot
:members:
:undoc-members:
:show-inheritance:
pype.fusion.scripts.publish\_filesequence module
------------------------------------------------
.. automodule:: pype.fusion.scripts.publish_filesequence
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,20 @@
pype.houdini package
====================
.. automodule:: pype.houdini
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.houdini.lib module
-----------------------
.. automodule:: pype.houdini.lib
:members:
:undoc-members:
:show-inheritance:

52
docs/source/pype.maya.rst Normal file
View file

@ -0,0 +1,52 @@
pype.maya package
=================
.. automodule:: pype.maya
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.maya.action module
-----------------------
.. automodule:: pype.maya.action
:members:
:undoc-members:
:show-inheritance:
pype.maya.customize module
--------------------------
.. automodule:: pype.maya.customize
:members:
:undoc-members:
:show-inheritance:
pype.maya.lib module
--------------------
.. automodule:: pype.maya.lib
:members:
:undoc-members:
:show-inheritance:
pype.maya.menu module
---------------------
.. automodule:: pype.maya.menu
:members:
:undoc-members:
:show-inheritance:
pype.maya.plugin module
-----------------------
.. automodule:: pype.maya.plugin
:members:
:undoc-members:
:show-inheritance:

44
docs/source/pype.nuke.rst Normal file
View file

@ -0,0 +1,44 @@
pype.nuke package
=================
.. automodule:: pype.nuke
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.nuke.actions module
------------------------
.. automodule:: pype.nuke.actions
:members:
:undoc-members:
:show-inheritance:
pype.nuke.lib module
--------------------
.. automodule:: pype.nuke.lib
:members:
:undoc-members:
:show-inheritance:
pype.nuke.menu module
---------------------
.. automodule:: pype.nuke.menu
:members:
:undoc-members:
:show-inheritance:
pype.nuke.templates module
--------------------------
.. automodule:: pype.nuke.templates
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,20 @@
pype.premiere package
=====================
.. automodule:: pype.premiere
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.premiere.templates module
------------------------------
.. automodule:: pype.premiere.templates
:members:
:undoc-members:
:show-inheritance:

88
docs/source/pype.rst Normal file
View file

@ -0,0 +1,88 @@
pype package
============
.. automodule:: pype
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
pype.aport
pype.avalon_apps
pype.clockify
pype.ftrack
pype.fusion
pype.houdini
pype.maya
pype.nuke
pype.premiere
pype.scripts
pype.services
pype.standalonepublish
pype.tools
pype.widgets
Submodules
----------
pype.action module
------------------
.. automodule:: pype.action
:members:
:undoc-members:
:show-inheritance:
pype.api module
---------------
.. automodule:: pype.api
:members:
:undoc-members:
:show-inheritance:
pype.launcher\_actions module
-----------------------------
.. automodule:: pype.launcher_actions
:members:
:undoc-members:
:show-inheritance:
pype.lib module
---------------
.. automodule:: pype.lib
:members:
:undoc-members:
:show-inheritance:
pype.plugin module
------------------
.. automodule:: pype.plugin
:members:
:undoc-members:
:show-inheritance:
pype.setdress\_api module
-------------------------
.. automodule:: pype.setdress_api
:members:
:undoc-members:
:show-inheritance:
pype.templates module
---------------------
.. automodule:: pype.templates
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,28 @@
pype.scripts package
====================
.. automodule:: pype.scripts
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.scripts.fusion\_switch\_shot module
----------------------------------------
.. automodule:: pype.scripts.fusion_switch_shot
:members:
:undoc-members:
:show-inheritance:
pype.scripts.publish\_filesequence module
-----------------------------------------
.. automodule:: pype.scripts.publish_filesequence
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,20 @@
pype.services.idle\_manager package
===================================
.. automodule:: pype.services.idle_manager
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.services.idle\_manager.idle\_manager module
------------------------------------------------
.. automodule:: pype.services.idle_manager.idle_manager
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,17 @@
pype.services package
=====================
.. automodule:: pype.services
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
pype.services.idle_manager
pype.services.statics_server
pype.services.timers_manager

View file

@ -0,0 +1,20 @@
pype.services.statics\_server package
=====================================
.. automodule:: pype.services.statics_server
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.services.statics\_server.statics\_server module
----------------------------------------------------
.. automodule:: pype.services.statics_server.statics_server
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,28 @@
pype.services.timers\_manager package
=====================================
.. automodule:: pype.services.timers_manager
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.services.timers\_manager.timers\_manager module
----------------------------------------------------
.. automodule:: pype.services.timers_manager.timers_manager
:members:
:undoc-members:
:show-inheritance:
pype.services.timers\_manager.widget\_user\_idle module
-------------------------------------------------------
.. automodule:: pype.services.timers_manager.widget_user_idle
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,8 @@
pype.standalonepublish.resources package
========================================
.. automodule:: pype.standalonepublish.resources
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,44 @@
pype.standalonepublish package
==============================
.. automodule:: pype.standalonepublish
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
pype.standalonepublish.resources
pype.standalonepublish.widgets
Submodules
----------
pype.standalonepublish.app module
---------------------------------
.. automodule:: pype.standalonepublish.app
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.publish module
-------------------------------------
.. automodule:: pype.standalonepublish.publish
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.standalonepublish\_module module
-------------------------------------------------------
.. automodule:: pype.standalonepublish.standalonepublish_module
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,156 @@
pype.standalonepublish.widgets package
======================================
.. automodule:: pype.standalonepublish.widgets
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.standalonepublish.widgets.button\_from\_svgs module
--------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.button_from_svgs
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_asset module
--------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_asset
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_filter\_proxy\_exact\_match module
------------------------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_filter_proxy_exact_match
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_filter\_proxy\_recursive\_sort module
---------------------------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_filter_proxy_recursive_sort
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_node module
-------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_node
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_tasks\_template module
------------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_tasks_template
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_tree module
-------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_tree
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_tree\_view\_deselectable module
---------------------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_tree_view_deselectable
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_asset module
---------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_asset
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_asset\_view module
---------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_asset_view
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_component\_item module
-------------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_component_item
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_components module
--------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_components
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_components\_list module
--------------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_components_list
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_drop\_empty module
---------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_drop_empty
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_drop\_frame module
---------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_drop_frame
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_family module
----------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_family
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_family\_desc module
----------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_family_desc
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_shadow module
----------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_shadow
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,36 @@
pype.tools.assetcreator package
===============================
.. automodule:: pype.tools.assetcreator
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.tools.assetcreator.app module
----------------------------------
.. automodule:: pype.tools.assetcreator.app
:members:
:undoc-members:
:show-inheritance:
pype.tools.assetcreator.model module
------------------------------------
.. automodule:: pype.tools.assetcreator.model
:members:
:undoc-members:
:show-inheritance:
pype.tools.assetcreator.widget module
-------------------------------------
.. automodule:: pype.tools.assetcreator.widget
:members:
:undoc-members:
:show-inheritance:

View file

@ -0,0 +1,15 @@
pype.tools package
==================
.. automodule:: pype.tools
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
pype.tools.assetcreator

View file

@ -0,0 +1,36 @@
pype.widgets package
====================
.. automodule:: pype.widgets
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.widgets.message\_window module
-----------------------------------
.. automodule:: pype.widgets.message_window
:members:
:undoc-members:
:show-inheritance:
pype.widgets.popup module
-------------------------
.. automodule:: pype.widgets.popup
:members:
:undoc-members:
:show-inheritance:
pype.widgets.project\_settings module
-------------------------------------
.. automodule:: pype.widgets.project_settings
:members:
:undoc-members:
:show-inheritance:

1
docs/source/readme.rst Normal file
View file

@ -0,0 +1 @@
.. include:: ../../README.md