Skip to content

Commit

Permalink
#202: sphinx-apidoc -o docs onlinejudge
Browse files Browse the repository at this point in the history
  • Loading branch information
kmyk committed Dec 5, 2018
1 parent 11d27af commit 3141173
Show file tree
Hide file tree
Showing 6 changed files with 278 additions and 4 deletions.
6 changes: 4 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc',
'sphinx_autodoc_typehints',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx.ext.todo',
'sphinx.ext.viewcode']

Expand Down Expand Up @@ -93,7 +93,9 @@
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
html_theme_options = {
'navigation_depth': 10,
}

# 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,
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Welcome to online-judge-tools's documentation!
==============================================

.. toctree::
:maxdepth: 2
:maxdepth: 10
:caption: Contents:

modules
Expand Down
2 changes: 1 addition & 1 deletion docs/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ onlinejudge
===========

.. toctree::
:maxdepth: 4
:maxdepth: 10

onlinejudge
102 changes: 102 additions & 0 deletions docs/onlinejudge.implementation.command.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
onlinejudge\.implementation\.command package
============================================

Submodules
----------

onlinejudge\.implementation\.command\.code\_statistics module
-------------------------------------------------------------

.. automodule:: onlinejudge.implementation.command.code_statistics
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.command\.download module
-----------------------------------------------------

.. automodule:: onlinejudge.implementation.command.download
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.command\.generate\_output module
-------------------------------------------------------------

.. automodule:: onlinejudge.implementation.command.generate_output
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.command\.generate\_scanner module
--------------------------------------------------------------

.. automodule:: onlinejudge.implementation.command.generate_scanner
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.command\.get\_standings module
-----------------------------------------------------------

.. automodule:: onlinejudge.implementation.command.get_standings
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.command\.login module
--------------------------------------------------

.. automodule:: onlinejudge.implementation.command.login
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.command\.split\_input module
---------------------------------------------------------

.. automodule:: onlinejudge.implementation.command.split_input
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.command\.submit module
---------------------------------------------------

.. automodule:: onlinejudge.implementation.command.submit
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.command\.test module
-------------------------------------------------

.. automodule:: onlinejudge.implementation.command.test
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.command\.test\_reactive module
-----------------------------------------------------------

.. automodule:: onlinejudge.implementation.command.test_reactive
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.command\.utils module
--------------------------------------------------

.. automodule:: onlinejudge.implementation.command.utils
:members:
:undoc-members:
:show-inheritance:


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

.. automodule:: onlinejudge.implementation.command
:members:
:undoc-members:
:show-inheritance:
53 changes: 53 additions & 0 deletions docs/onlinejudge.implementation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
onlinejudge\.implementation package
===================================

Subpackages
-----------

.. toctree::

onlinejudge.implementation.command

Submodules
----------

onlinejudge\.implementation\.logging module
-------------------------------------------

.. automodule:: onlinejudge.implementation.logging
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.main module
----------------------------------------

.. automodule:: onlinejudge.implementation.main
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.utils module
-----------------------------------------

.. automodule:: onlinejudge.implementation.utils
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.implementation\.version module
-------------------------------------------

.. automodule:: onlinejudge.implementation.version
:members:
:undoc-members:
:show-inheritance:


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

.. automodule:: onlinejudge.implementation
:members:
:undoc-members:
:show-inheritance:
117 changes: 117 additions & 0 deletions docs/onlinejudge.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
onlinejudge package
===================

Subpackages
-----------

.. toctree::

onlinejudge.implementation

Submodules
----------

onlinejudge\.anarchygolf module
-------------------------------

.. automodule:: onlinejudge.anarchygolf
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.aoj module
-----------------------

.. automodule:: onlinejudge.aoj
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.atcoder module
---------------------------

.. automodule:: onlinejudge.atcoder
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.codeforces module
------------------------------

.. automodule:: onlinejudge.codeforces
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.csacademy module
-----------------------------

.. automodule:: onlinejudge.csacademy
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.dispatch module
----------------------------

.. automodule:: onlinejudge.dispatch
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.hackerrank module
------------------------------

.. automodule:: onlinejudge.hackerrank
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.problem module
---------------------------

.. automodule:: onlinejudge.problem
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.service module
---------------------------

.. automodule:: onlinejudge.service
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.submission module
------------------------------

.. automodule:: onlinejudge.submission
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.topcoder module
----------------------------

.. automodule:: onlinejudge.topcoder
:members:
:undoc-members:
:show-inheritance:

onlinejudge\.yukicoder module
-----------------------------

.. automodule:: onlinejudge.yukicoder
:members:
:undoc-members:
:show-inheritance:


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

.. automodule:: onlinejudge
:members:
:undoc-members:
:show-inheritance:

0 comments on commit 3141173

Please sign in to comment.