Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
o3bvv committed Jan 5, 2016
1 parent 9604895 commit d2ce033
Show file tree
Hide file tree
Showing 34 changed files with 773 additions and 388 deletions.
6 changes: 3 additions & 3 deletions docs/conf.py
Expand Up @@ -60,9 +60,9 @@
# built documents.
#
# The short X.Y version.
version = '1.0'
version = '1.1'
# The full version, including alpha/beta/rc tags.
release = '1.0.0'
release = '1.1.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -113,7 +113,7 @@
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
'sidebarwidth': 280,
'sidebarwidth': 330,
}

# Add any paths that contain custom themes here, relative to this directory.
Expand Down
26 changes: 18 additions & 8 deletions docs/il2fb.parsers.mission.rst
Expand Up @@ -12,29 +12,39 @@ il2fb.parsers.mission.constants module
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.utils module
------------------------------------
il2fb.parsers.mission.converters module
---------------------------------------

.. automodule:: il2fb.parsers.mission.utils
.. automodule:: il2fb.parsers.mission.converters
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.exceptions module
---------------------------------------

.. automodule:: il2fb.parsers.mission.exceptions
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.parsers module

il2fb.parsers.mission.utils module
------------------------------------

.. automodule:: il2fb.parsers.mission.parsers
.. automodule:: il2fb.parsers.mission.utils
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.regiments module
--------------------------------------
il2fb.parsers.mission.sections module
-------------------------------------

.. automodule:: il2fb.parsers.mission.regiments
.. automodule:: il2fb.parsers.mission.sections
:members:
:undoc-members:
:show-inheritance:
:noindex:


Module contents
Expand Down
126 changes: 126 additions & 0 deletions docs/il2fb.parsers.mission.sections.rst
@@ -0,0 +1,126 @@
il2fb.parsers.mission.sections package
======================================

Submodules
----------

il2fb.parsers.mission.sections.born_place module
------------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.born_place
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.buildings module
-----------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.buildings
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.chiefs module
--------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.chiefs
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.front_marker module
--------------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.front_marker
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.main module
------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.main
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.mds module
-----------------------------------------

.. automodule:: il2fb.parsers.mission.sections.mds
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.nstationary module
-------------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.nstationary
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.respawn_time module
--------------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.respawn_time
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.rocket module
--------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.rocket
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.season module
--------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.season
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.static_camera module
---------------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.static_camera
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.target module
--------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.target
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.weather module
---------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.weather
:members:
:undoc-members:
:show-inheritance:

il2fb.parsers.mission.sections.wing module
------------------------------------------

.. automodule:: il2fb.parsers.mission.sections.wing
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: il2fb.parsers.mission.sections
:members:
:undoc-members:
:show-inheritance:
14 changes: 4 additions & 10 deletions docs/index.rst
Expand Up @@ -19,8 +19,8 @@ IL-2 FB Mission Parser


``il2fb-mission-parser`` — is a free Python library for parsing mission files
of IL-2 FB aviasim. It helps you to convert a text file in a tricky format into
a pretty Python object.
of IL-2 FB aviasimulator. It helps you to convert a text file in a tricky
format into a pretty Python object.


Contents:
Expand All @@ -31,18 +31,12 @@ Contents:

installation
usage
mission-parser
comments-in-missions
section-parsing
sections/section-parsing
demo


Modules:

.. toctree::
:maxdepth: 2

modules.rst

Project's repository:

https://github.com/IL2HorusTeam/il2fb-mission-parser
Expand Down

0 comments on commit d2ce033

Please sign in to comment.