AstralTransRocketries/mcedit2
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add target to doc/Makefile for running sphinx-apidoc

Browse Source 
Replace 'mceditlib' with 'mcedit2' in doc info
This commit is contained in:
David Vierra 2015-07-17 01:59:00 -10:00
parent 1649dcf28b
commit 697fa78fca
38 changed files with 1772 additions and 1491 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/Makefile
View File

@ -14,7 +14,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others # the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext apidoc
help: help:
@echo "Please use \`make <target>' where <target> is one of" @echo "Please use \`make <target>' where <target> is one of"
@ -37,6 +37,7 @@ help:
@echo " changes to make an overview of all changed/added/deprecated items" @echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity" @echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)" @echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " apidoc to regenerate all .rst files created by sphinx-apidoc"
clean: clean:
-rm -rf $(BUILDDIR)/* -rm -rf $(BUILDDIR)/*
@ -151,3 +152,7 @@ doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \ @echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt." "results in $(BUILDDIR)/doctest/output.txt."
apidoc:
sphinx-apidoc -o apidoc -f ../src/mceditlib ../src/mceditlib/test
sphinx-apidoc -o apidoc -f ../src/mcedit2 ../src/mcedit2/test

30
doc/apidoc/mcedit2.dialogs.rst Normal file
View File

@ -0,0 +1,30 @@
mcedit2.dialogs package
=======================
Submodules
----------
mcedit2.dialogs.error_dialog module
-----------------------------------
.. automodule:: mcedit2.dialogs.error_dialog
:members:
:undoc-members:
:show-inheritance:
mcedit2.dialogs.plugins_dialog module
-------------------------------------
.. automodule:: mcedit2.dialogs.plugins_dialog
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mcedit2.dialogs
:members:
:undoc-members:
:show-inheritance:

8
doc/mcedit2.editorcommands.rst → doc/apidoc/mcedit2.editorcommands.rst
View File

@ -4,6 +4,14 @@ mcedit2.editorcommands package
Submodules Submodules
---------- ----------
mcedit2.editorcommands.analyze module
-------------------------------------
.. automodule:: mcedit2.editorcommands.analyze
:members:
:undoc-members:
:show-inheritance:
mcedit2.editorcommands.fill module mcedit2.editorcommands.fill module
---------------------------------- ----------------------------------

38
doc/apidoc/mcedit2.editortools.brush.rst Normal file
View File

@ -0,0 +1,38 @@
mcedit2.editortools.brush package
=================================
Submodules
----------
mcedit2.editortools.brush.masklevel module
------------------------------------------
.. automodule:: mcedit2.editortools.brush.masklevel
:members:
:undoc-members:
:show-inheritance:
mcedit2.editortools.brush.modes module
--------------------------------------
.. automodule:: mcedit2.editortools.brush.modes
:members:
:undoc-members:
:show-inheritance:
mcedit2.editortools.brush.shapes module
---------------------------------------
.. automodule:: mcedit2.editortools.brush.shapes
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mcedit2.editortools.brush
:members:
:undoc-members:
:show-inheritance:

24
doc/mcedit2.editortools.rst → doc/apidoc/mcedit2.editortools.rst
View File

@ -19,14 +19,6 @@ mcedit2.editortools.edit_chunk module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.editortools.edit_entity module
--------------------------------------
.. automodule:: mcedit2.editortools.edit_entity
:members:
:undoc-members:
:show-inheritance:
mcedit2.editortools.flood_fill module mcedit2.editortools.flood_fill module
------------------------------------- -------------------------------------
@ -59,6 +51,22 @@ mcedit2.editortools.select module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.editortools.select_block module
---------------------------------------
.. automodule:: mcedit2.editortools.select_block
:members:
:undoc-members:
:show-inheritance:
mcedit2.editortools.select_entity module
----------------------------------------
.. automodule:: mcedit2.editortools.select_entity
:members:
:undoc-members:
:show-inheritance:
Module contents Module contents
--------------- ---------------

0
doc/mcedit2.handles.rst → doc/apidoc/mcedit2.handles.rst
View File

38
doc/apidoc/mcedit2.panels.rst Normal file
View File

@ -0,0 +1,38 @@
mcedit2.panels package
======================
Submodules
----------
mcedit2.panels.map module
-------------------------
.. automodule:: mcedit2.panels.map
:members:
:undoc-members:
:show-inheritance:
mcedit2.panels.player module
----------------------------
.. automodule:: mcedit2.panels.player
:members:
:undoc-members:
:show-inheritance:
mcedit2.panels.worldinfo module
-------------------------------
.. automodule:: mcedit2.panels.worldinfo
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mcedit2.panels
:members:
:undoc-members:
:show-inheritance:

70
doc/apidoc/mcedit2.rendering.chunkmeshes.entity.rst Normal file
View File

@ -0,0 +1,70 @@
mcedit2.rendering.chunkmeshes.entity package
============================================
Submodules
----------
mcedit2.rendering.chunkmeshes.entity.biped module
-------------------------------------------------
.. automodule:: mcedit2.rendering.chunkmeshes.entity.biped
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.chunkmeshes.entity.creeper module
---------------------------------------------------
.. automodule:: mcedit2.rendering.chunkmeshes.entity.creeper
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.chunkmeshes.entity.modelrenderer module
---------------------------------------------------------
.. automodule:: mcedit2.rendering.chunkmeshes.entity.modelrenderer
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.chunkmeshes.entity.models module
--------------------------------------------------
.. automodule:: mcedit2.rendering.chunkmeshes.entity.models
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.chunkmeshes.entity.quadruped module
-----------------------------------------------------
.. automodule:: mcedit2.rendering.chunkmeshes.entity.quadruped
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.chunkmeshes.entity.spider module
--------------------------------------------------
.. automodule:: mcedit2.rendering.chunkmeshes.entity.spider
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.chunkmeshes.entity.villager module
----------------------------------------------------
.. automodule:: mcedit2.rendering.chunkmeshes.entity.villager
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mcedit2.rendering.chunkmeshes.entity
:members:
:undoc-members:
:show-inheritance:

15
doc/mcedit2.rendering.chunkmeshes.rst → doc/apidoc/mcedit2.rendering.chunkmeshes.rst
View File

@ -1,9 +1,24 @@
mcedit2.rendering.chunkmeshes package mcedit2.rendering.chunkmeshes package
===================================== =====================================
Subpackages
-----------
.. toctree::
mcedit2.rendering.chunkmeshes.entity
Submodules Submodules
---------- ----------
mcedit2.rendering.chunkmeshes.chunksections module
--------------------------------------------------
.. automodule:: mcedit2.rendering.chunkmeshes.chunksections
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.chunkmeshes.entitymesh module mcedit2.rendering.chunkmeshes.entitymesh module
----------------------------------------------- -----------------------------------------------

25
doc/mcedit2.rendering.rst → doc/apidoc/mcedit2.rendering.rst
View File

@ -7,6 +7,7 @@ Subpackages
.. toctree:: .. toctree::
mcedit2.rendering.chunkmeshes mcedit2.rendering.chunkmeshes
mcedit2.rendering.scenegraph
Submodules Submodules
---------- ----------
@ -123,14 +124,6 @@ mcedit2.rendering.modelmesh module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.rendering.rendergraph module
------------------------------------
.. automodule:: mcedit2.rendering.rendergraph
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.renderstates module mcedit2.rendering.renderstates module
------------------------------------- -------------------------------------
@ -139,14 +132,6 @@ mcedit2.rendering.renderstates module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.rendering.scenegraph module
-----------------------------------
.. automodule:: mcedit2.rendering.scenegraph
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.selection module mcedit2.rendering.selection module
---------------------------------- ----------------------------------
@ -187,6 +172,14 @@ mcedit2.rendering.vertexarraybuffer module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.rendering.workplane module
----------------------------------
.. automodule:: mcedit2.rendering.workplane
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.worldscene module mcedit2.rendering.worldscene module
----------------------------------- -----------------------------------

78
doc/apidoc/mcedit2.rendering.scenegraph.rst Normal file
View File

@ -0,0 +1,78 @@
mcedit2.rendering.scenegraph package
====================================
Submodules
----------
mcedit2.rendering.scenegraph.bind_texture module
------------------------------------------------
.. automodule:: mcedit2.rendering.scenegraph.bind_texture
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.scenegraph.depth_test module
----------------------------------------------
.. automodule:: mcedit2.rendering.scenegraph.depth_test
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.scenegraph.matrix module
------------------------------------------
.. automodule:: mcedit2.rendering.scenegraph.matrix
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.scenegraph.misc module
----------------------------------------
.. automodule:: mcedit2.rendering.scenegraph.misc
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.scenegraph.rendernode module
----------------------------------------------
.. automodule:: mcedit2.rendering.scenegraph.rendernode
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.scenegraph.scenenode module
---------------------------------------------
.. automodule:: mcedit2.rendering.scenegraph.scenenode
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.scenegraph.texture_atlas module
-------------------------------------------------
.. automodule:: mcedit2.rendering.scenegraph.texture_atlas
:members:
:undoc-members:
:show-inheritance:
mcedit2.rendering.scenegraph.vertex_array module
------------------------------------------------
.. automodule:: mcedit2.rendering.scenegraph.vertex_array
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mcedit2.rendering.scenegraph
:members:
:undoc-members:
:show-inheritance:

20
doc/mcedit2.rst → doc/apidoc/mcedit2.rst
View File

@ -6,13 +6,13 @@ Subpackages
.. toctree:: .. toctree::
mcedit2.dialogs
mcedit2.editorcommands mcedit2.editorcommands
mcedit2.editortools mcedit2.editortools
mcedit2.handles mcedit2.handles
mcedit2.panels mcedit2.panels
mcedit2.prefs
mcedit2.rendering mcedit2.rendering
mcedit2.ui mcedit2.synth
mcedit2.util mcedit2.util
mcedit2.widgets mcedit2.widgets
mcedit2.worldview mcedit2.worldview
@ -20,6 +20,14 @@ Subpackages
Submodules Submodules
---------- ----------
mcedit2.appsettings module
--------------------------
.. automodule:: mcedit2.appsettings
:members:
:undoc-members:
:show-inheritance:
mcedit2.command module mcedit2.command module
---------------------- ----------------------
@ -60,6 +68,14 @@ mcedit2.main module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.plugins module
----------------------
.. automodule:: mcedit2.plugins
:members:
:undoc-members:
:show-inheritance:
mcedit2.resourceloader module mcedit2.resourceloader module
----------------------------- -----------------------------

30
doc/apidoc/mcedit2.synth.rst Normal file
View File

@ -0,0 +1,30 @@
mcedit2.synth package
=====================
Submodules
----------
mcedit2.synth.l_system module
-----------------------------
.. automodule:: mcedit2.synth.l_system
:members:
:undoc-members:
:show-inheritance:
mcedit2.synth.l_system_plugin module
------------------------------------
.. automodule:: mcedit2.synth.l_system_plugin
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mcedit2.synth
:members:
:undoc-members:
:show-inheritance:

38
doc/apidoc/mcedit2.util.directories.rst Normal file
View File

@ -0,0 +1,38 @@
mcedit2.util.directories package
================================
Submodules
----------
mcedit2.util.directories.mac module
-----------------------------------
.. automodule:: mcedit2.util.directories.mac
:members:
:undoc-members:
:show-inheritance:
mcedit2.util.directories.posix module
-------------------------------------
.. automodule:: mcedit2.util.directories.posix
:members:
:undoc-members:
:show-inheritance:
mcedit2.util.directories.win32 module
-------------------------------------
.. automodule:: mcedit2.util.directories.win32
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mcedit2.util.directories
:members:
:undoc-members:
:show-inheritance:

63
doc/mcedit2.util.rst → doc/apidoc/mcedit2.util.rst
View File

@ -1,6 +1,13 @@
mcedit2.util package mcedit2.util package
==================== ====================
Subpackages
-----------
.. toctree::
mcedit2.util.directories
Submodules Submodules
---------- ----------
@ -20,6 +27,14 @@ mcedit2.util.bugfixes module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.util.commandblock module
--------------------------------
.. automodule:: mcedit2.util.commandblock
:members:
:undoc-members:
:show-inheritance:
mcedit2.util.custom_traceback module mcedit2.util.custom_traceback module
------------------------------------ ------------------------------------
@ -36,22 +51,6 @@ mcedit2.util.dialogs module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.util.directories module
-------------------------------
.. automodule:: mcedit2.util.directories
:members:
:undoc-members:
:show-inheritance:
mcedit2.util.geometry module
----------------------------
.. automodule:: mcedit2.util.geometry
:members:
:undoc-members:
:show-inheritance:
mcedit2.util.glutils module mcedit2.util.glutils module
--------------------------- ---------------------------
@ -68,14 +67,6 @@ mcedit2.util.ipython_widget module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.util.lazyprop module
----------------------------
.. automodule:: mcedit2.util.lazyprop
:members:
:undoc-members:
:show-inheritance:
mcedit2.util.load_png module mcedit2.util.load_png module
---------------------------- ----------------------------
@ -100,6 +91,14 @@ mcedit2.util.mceaction module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.util.mimeformats module
-------------------------------
.. automodule:: mcedit2.util.mimeformats
:members:
:undoc-members:
:show-inheritance:
mcedit2.util.minecraftinstall module mcedit2.util.minecraftinstall module
------------------------------------ ------------------------------------
@ -132,6 +131,14 @@ mcedit2.util.profilerui module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.util.qglcontext module
------------------------------
.. automodule:: mcedit2.util.qglcontext
:members:
:undoc-members:
:show-inheritance:
mcedit2.util.raycast module mcedit2.util.raycast module
--------------------------- ---------------------------
@ -148,14 +155,6 @@ mcedit2.util.resources module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.util.scanmodules module
-------------------------------
.. automodule:: mcedit2.util.scanmodules
:members:
:undoc-members:
:show-inheritance:
mcedit2.util.screen module mcedit2.util.screen module
-------------------------- --------------------------

17
doc/apidoc/mcedit2.widgets.inspector.rst Normal file
View File

@ -0,0 +1,17 @@
mcedit2.widgets.inspector package
=================================
Subpackages
-----------
.. toctree::
mcedit2.widgets.inspector.tileentities
Module contents
---------------
.. automodule:: mcedit2.widgets.inspector
:members:
:undoc-members:
:show-inheritance:

30
doc/apidoc/mcedit2.widgets.inspector.tileentities.rst Normal file
View File

@ -0,0 +1,30 @@
mcedit2.widgets.inspector.tileentities package
==============================================
Submodules
----------
mcedit2.widgets.inspector.tileentities.chest module
---------------------------------------------------
.. automodule:: mcedit2.widgets.inspector.tileentities.chest
:members:
:undoc-members:
:show-inheritance:
mcedit2.widgets.inspector.tileentities.command module
-----------------------------------------------------
.. automodule:: mcedit2.widgets.inspector.tileentities.command
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mcedit2.widgets.inspector.tileentities
:members:
:undoc-members:
:show-inheritance:

0
doc/mcedit2.widgets.nbttree.rst → doc/apidoc/mcedit2.widgets.nbttree.rst
View File

33
doc/mcedit2.widgets.rst → doc/apidoc/mcedit2.widgets.rst
View File

@ -6,6 +6,7 @@ Subpackages
.. toctree:: .. toctree::
mcedit2.widgets.inspector
mcedit2.widgets.nbttree mcedit2.widgets.nbttree
Submodules Submodules
@ -27,6 +28,14 @@ mcedit2.widgets.blocktype_list module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.widgets.configureblocksdialog module
--------------------------------------------
.. automodule:: mcedit2.widgets.configureblocksdialog
:members:
:undoc-members:
:show-inheritance:
mcedit2.widgets.flowlayout module mcedit2.widgets.flowlayout module
--------------------------------- ---------------------------------
@ -43,6 +52,22 @@ mcedit2.widgets.infopanel module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.widgets.inventory module
--------------------------------
.. automodule:: mcedit2.widgets.inventory
:members:
:undoc-members:
:show-inheritance:
mcedit2.widgets.itemtype_list module
------------------------------------
.. automodule:: mcedit2.widgets.itemtype_list
:members:
:undoc-members:
:show-inheritance:
mcedit2.widgets.layout module mcedit2.widgets.layout module
----------------------------- -----------------------------
@ -67,6 +92,14 @@ mcedit2.widgets.objectinspector module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mcedit2.widgets.prefsdialog module
----------------------------------
.. automodule:: mcedit2.widgets.prefsdialog
:members:
:undoc-members:
:show-inheritance:
mcedit2.widgets.propertylist module mcedit2.widgets.propertylist module
----------------------------------- -----------------------------------

0
doc/mcedit2.worldview.rst → doc/apidoc/mcedit2.worldview.rst
View File

0
doc/mceditlib.anvil.rst → doc/apidoc/mceditlib.anvil.rst
View File

30
doc/apidoc/mceditlib.blocktypes.rst Normal file
View File

@ -0,0 +1,30 @@
mceditlib.blocktypes package
============================
Submodules
----------
mceditlib.blocktypes.itemtypes module
-------------------------------------
.. automodule:: mceditlib.blocktypes.itemtypes
:members:
:undoc-members:
:show-inheritance:
mceditlib.blocktypes.json_resources module
------------------------------------------
.. automodule:: mceditlib.blocktypes.json_resources
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mceditlib.blocktypes
:members:
:undoc-members:
:show-inheritance:

8
doc/mceditlib.operations.rst → doc/apidoc/mceditlib.operations.rst
View File

@ -4,6 +4,14 @@ mceditlib.operations package
Submodules Submodules
---------- ----------
mceditlib.operations.analyze module
-----------------------------------
.. automodule:: mceditlib.operations.analyze
:members:
:undoc-members:
:show-inheritance:
mceditlib.operations.block_fill module mceditlib.operations.block_fill module
-------------------------------------- --------------------------------------

0
doc/mceditlib.pc.rst → doc/apidoc/mceditlib.pc.rst
View File

46
doc/apidoc/mceditlib.relight.rst Normal file
View File

@ -0,0 +1,46 @@
mceditlib.relight package
=========================
Submodules
----------
mceditlib.relight.pure_python module
------------------------------------
.. automodule:: mceditlib.relight.pure_python
:members:
:undoc-members:
:show-inheritance:
mceditlib.relight.with_cython module
------------------------------------
.. automodule:: mceditlib.relight.with_cython
:members:
:undoc-members:
:show-inheritance:
mceditlib.relight.with_sections module
--------------------------------------
.. automodule:: mceditlib.relight.with_sections
:members:
:undoc-members:
:show-inheritance:
mceditlib.relight.with_setblocks module
---------------------------------------
.. automodule:: mceditlib.relight.with_setblocks
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mceditlib.relight
:members:
:undoc-members:
:show-inheritance:

42
doc/mceditlib.rst → doc/apidoc/mceditlib.rst
View File

@ -10,8 +10,8 @@ Subpackages
mceditlib.blocktypes mceditlib.blocktypes
mceditlib.operations mceditlib.operations
mceditlib.pc mceditlib.pc
mceditlib.relight
mceditlib.selection mceditlib.selection
mceditlib.test
mceditlib.util mceditlib.util
Submodules Submodules
@ -73,6 +73,14 @@ mceditlib.faces module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mceditlib.fakechunklevel module
-------------------------------
.. automodule:: mceditlib.fakechunklevel
:members:
:undoc-members:
:show-inheritance:
mceditlib.findadapter module mceditlib.findadapter module
---------------------------- ----------------------------
@ -97,14 +105,6 @@ mceditlib.heightmaps module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mceditlib.items module
----------------------
.. automodule:: mceditlib.items
:members:
:undoc-members:
:show-inheritance:
mceditlib.java module mceditlib.java module
--------------------- ---------------------
@ -113,14 +113,6 @@ mceditlib.java module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mceditlib.fakechunklevel module
--------------------------
.. automodule:: mceditlib.fakechunklevel
:members:
:undoc-members:
:show-inheritance:
mceditlib.minecraft_server module mceditlib.minecraft_server module
--------------------------------- ---------------------------------
@ -161,14 +153,6 @@ mceditlib.pocket module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mceditlib.relight module
------------------------
.. automodule:: mceditlib.relight
:members:
:undoc-members:
:show-inheritance:
mceditlib.revisionhistory module mceditlib.revisionhistory module
-------------------------------- --------------------------------
@ -177,14 +161,6 @@ mceditlib.revisionhistory module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mceditlib.run_regression_test module
------------------------------------
.. automodule:: mceditlib.run_regression_test
:members:
:undoc-members:
:show-inheritance:
mceditlib.schematic module mceditlib.schematic module
-------------------------- --------------------------

0
doc/mceditlib.selection.rst → doc/apidoc/mceditlib.selection.rst
View File

38
doc/apidoc/mceditlib.util.rst Normal file
View File

@ -0,0 +1,38 @@
mceditlib.util package
======================
Submodules
----------
mceditlib.util.demjson module
-----------------------------
.. automodule:: mceditlib.util.demjson
:members:
:undoc-members:
:show-inheritance:
mceditlib.util.lazyprop module
------------------------------
.. automodule:: mceditlib.util.lazyprop
:members:
:undoc-members:
:show-inheritance:
mceditlib.util.unique_nd module
-------------------------------
.. automodule:: mceditlib.util.unique_nd
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mceditlib.util
:members:
:undoc-members:
:show-inheritance:

5
doc/modules.rst → doc/apidoc/modules.rst
View File

@ -1,8 +1,7 @@
. mcedit2
= =======
.. toctree:: .. toctree::
:maxdepth: 4 :maxdepth: 4
mcedit2 mcedit2
mceditlib

18
doc/conf.py
View File

@ -16,7 +16,7 @@ import sys, os
# If extensions (or modules to document with autodoc) are in another directory, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('..')) # Folder containing mceditlib sys.path.insert(0, os.path.abspath('../src')) # Folder containing mceditlib and mcedit2
sys.path.insert(0, os.path.abspath('extensions')) # extensions sys.path.insert(0, os.path.abspath('extensions')) # extensions
# -- General configuration ----------------------------------------------------- # -- General configuration -----------------------------------------------------
@ -41,7 +41,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'mceditlib' project = u'mcedit2'
copyright = u'2013, David Vierra' copyright = u'2013, David Vierra'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
@ -49,9 +49,9 @@ copyright = u'2013, David Vierra'
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '0.1' version = '2.0'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.1' release = '2.0-alpha'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -165,7 +165,7 @@ html_static_path = ['_static']
#html_file_suffix = None #html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'mceditlibdoc' htmlhelp_basename = 'mcedit2doc'
# -- Options for LaTeX output -------------------------------------------------- # -- Options for LaTeX output --------------------------------------------------
@ -184,7 +184,7 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'mceditlib.tex', u'mceditlib Documentation', ('index', 'mcedit2.tex', u'mceditlib Documentation',
u'David Vierra', 'manual'), u'David Vierra', 'manual'),
] ]
@ -214,7 +214,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'mceditlib', u'mceditlib Documentation', ('index', 'mcedit2', u'mcedit2 Documentation',
[u'David Vierra'], 1) [u'David Vierra'], 1)
] ]
@ -228,8 +228,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'mceditlib', u'mceditlib Documentation', ('index', 'mcedit2', u'mcedit2 Documentation',
u'David Vierra', 'mceditlib', 'One line description of project.', u'David Vierra', 'mcedit2', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]

6
doc/index.rst
View File

@ -6,13 +6,13 @@
Welcome to mceditlib's documentation! Welcome to mceditlib's documentation!
===================================== =====================================
Contents: API Documentation:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
mceditlib apidoc/mceditlib
mcedit2 apidoc/mcedit2
Indices and tables Indices and tables
================== ==================

10
doc/mcedit2.editortools.brush.rst
View File

@ -1,10 +0,0 @@
mcedit2.editortools.brush package
=================================
Module contents
---------------
.. automodule:: mcedit2.editortools.brush
:members:
:undoc-members:
:show-inheritance:

22
doc/mcedit2.panels.rst
View File

@ -1,22 +0,0 @@
mcedit2.panels package
======================
Submodules
----------
mcedit2.panels.player module
----------------------------
.. automodule:: mcedit2.panels.player
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mcedit2.panels
:members:
:undoc-members:
:show-inheritance:

30
doc/mcedit2.prefs.rst
View File

@ -1,30 +0,0 @@
mcedit2.prefs package
=====================
Submodules
----------
mcedit2.prefs.prefswindow module
--------------------------------
.. automodule:: mcedit2.prefs.prefswindow
:members:
:undoc-members:
:show-inheritance:
mcedit2.prefs.raw module
------------------------
.. automodule:: mcedit2.prefs.raw
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mcedit2.prefs
:members:
:undoc-members:
:show-inheritance:

10
doc/mcedit2.ui.rst
View File

@ -1,10 +0,0 @@
mcedit2.ui package
==================
Module contents
---------------
.. automodule:: mcedit2.ui
:members:
:undoc-members:
:show-inheritance:

10
doc/mceditlib.blocktypes.rst
View File

@ -1,10 +0,0 @@
mceditlib.blocktypes package
============================
Module contents
---------------
.. automodule:: mceditlib.blocktypes
:members:
:undoc-members:
:show-inheritance:

158
doc/mceditlib.test.rst
View File

@ -1,158 +0,0 @@
mceditlib.test package
======================
Submodules
----------
mceditlib.test.anvil_test module
--------------------------------
.. automodule:: mceditlib.test.anvil_test
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.editing_test module
----------------------------------
.. automodule:: mceditlib.test.editing_test
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.entity_test module
---------------------------------
.. automodule:: mceditlib.test.entity_test
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.extended_id_test module
--------------------------------------
.. automodule:: mceditlib.test.extended_id_test
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.nbt_test module
------------------------------
.. automodule:: mceditlib.test.nbt_test
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.relight_test module
----------------------------------
.. automodule:: mceditlib.test.relight_test
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.revisionhistory_test module
------------------------------------------
.. automodule:: mceditlib.test.revisionhistory_test
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.schematic_test module
------------------------------------
.. automodule:: mceditlib.test.schematic_test
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.server_test module
---------------------------------
.. automodule:: mceditlib.test.server_test
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.session_lock_test module
---------------------------------------
.. automodule:: mceditlib.test.session_lock_test
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.templevel module
-------------------------------
.. automodule:: mceditlib.test.templevel
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.time_exportimport module
---------------------------------------
.. automodule:: mceditlib.test.time_exportimport
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.time_fill module
-------------------------------
.. automodule:: mceditlib.test.time_fill
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.time_getsetblocks module
---------------------------------------
.. automodule:: mceditlib.test.time_getsetblocks
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.time_loadsave module
-----------------------------------
.. automodule:: mceditlib.test.time_loadsave
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.time_nbt module
------------------------------
.. automodule:: mceditlib.test.time_nbt
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.time_relight module
----------------------------------
.. automodule:: mceditlib.test.time_relight
:members:
:undoc-members:
:show-inheritance:
mceditlib.test.time_storagechain module
---------------------------------------
.. automodule:: mceditlib.test.time_storagechain
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mceditlib.test
:members:
:undoc-members:
:show-inheritance:

22
doc/mceditlib.util.rst
View File

@ -1,22 +0,0 @@
mceditlib.util package
======================
Submodules
----------
mceditlib.util.unique_nd module
-------------------------------
.. automodule:: mceditlib.util.unique_nd
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mceditlib.util
:members:
:undoc-members:
:show-inheritance: