Skip to content

Commit

Permalink
Add auto generated docs from the docstrings (Sphinx-Autodocs)
Browse files Browse the repository at this point in the history
  • Loading branch information
guyandtheworld committed Jun 30, 2018
1 parent a23fdf0 commit 312b4c0
Show file tree
Hide file tree
Showing 11 changed files with 387 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = EvalAICLI
SOURCEDIR = .
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)
9 changes: 9 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Updating the documentation

Install dependencies:

`pip install -r requirements.txt`

Then use make to build the html:

`make html`
162 changes: 162 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
# -*- 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('../'))


# -- Project information -----------------------------------------------------

project = u'EvalAI CLI'
copyright = u'2018, Adarsh S'
author = u'Adarsh S'

# The short X.Y version
version = u''
# The full version, including alpha/beta/rc tags
release = u'1.0'


# -- 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.viewcode',
]

# 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 = [u'_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'


# -- 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 = 'alabaster'

# 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 = {}

# 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 = 'EvalAICLIdoc'


# -- 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, 'EvalAICLI.tex', u'EvalAI CLI Documentation',
u'Adarsh S', '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, 'evalaicli', u'EvalAI CLI 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, 'EvalAICLI', u'EvalAI CLI Documentation',
author, 'EvalAICLI', 'One line description of project.',
'Miscellaneous'),
]


# -- Extension configuration -------------------------------------------------
20 changes: 20 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. EvalAI CLI documentation master file, created by
sphinx-quickstart on Wed Jun 27 17:54:36 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to EvalAI CLI's documentation!
======================================

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



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
36 changes: 36 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=EvalAICLI

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
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Sphinx==1.7.5
sphinx-rtd-theme==0.4.0
61 changes: 61 additions & 0 deletions docs/source/evalai.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
evalai package
==============

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

.. toctree::

evalai.utils

Submodules
----------

evalai.challenges module
------------------------

.. automodule:: evalai.challenges
:members:
:undoc-members:
:show-inheritance:

evalai.main module
------------------

.. automodule:: evalai.main
:members:
:undoc-members:
:show-inheritance:

evalai.submissions module
-------------------------

.. automodule:: evalai.submissions
:members:
:undoc-members:
:show-inheritance:

evalai.teams module
-------------------

.. automodule:: evalai.teams
:members:
:undoc-members:
:show-inheritance:

evalai.urls module
------------------

.. automodule:: evalai.urls
:members:
:undoc-members:
:show-inheritance:


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

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

Submodules
----------

evalai.utils.auth module
------------------------

.. automodule:: evalai.utils.auth
:members:
:undoc-members:
:show-inheritance:

evalai.utils.challenges module
------------------------------

.. automodule:: evalai.utils.challenges
:members:
:undoc-members:
:show-inheritance:

evalai.utils.common module
--------------------------

.. automodule:: evalai.utils.common
:members:
:undoc-members:
:show-inheritance:

evalai.utils.config module
--------------------------

.. automodule:: evalai.utils.config
:members:
:undoc-members:
:show-inheritance:

evalai.utils.submissions module
-------------------------------

.. automodule:: evalai.utils.submissions
:members:
:undoc-members:
:show-inheritance:

evalai.utils.teams module
-------------------------

.. automodule:: evalai.utils.teams
:members:
:undoc-members:
:show-inheritance:

evalai.utils.urls module
------------------------

.. automodule:: evalai.utils.urls
:members:
:undoc-members:
:show-inheritance:


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

.. automodule:: evalai.utils
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
evalai
======

.. toctree::
:maxdepth: 4

evalai
Binary file removed docs/static/images/evalai_logo.png
Binary file not shown.
Binary file removed docs/static/images/kaggle_comparison.png
Binary file not shown.

0 comments on commit 312b4c0

Please sign in to comment.