Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,6 @@ Gemfile.lock
_site
.tox/
venv/
docs/_build/
docs/mobly*.rst
docs/modules.rst
31 changes: 31 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
import os
import sys

from sphinx.ext import apidoc

sys.path.insert(0, os.path.abspath(os.path.pardir))

# -- General configuration ------------------------------------------------
Expand Down Expand Up @@ -206,3 +208,32 @@

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']


def run_apidoc(_):
"""Automatically runs sphinx-apidoc on Sphinx builder initialization."""
cur_dir = os.path.abspath(os.path.dirname(__file__))
module_dir = os.path.abspath(os.path.join(cur_dir, os.path.pardir, 'mobly'))
output_dir = cur_dir

excludes = [
os.path.join(module_dir, '*_test.py'),
os.path.join(module_dir, '**', '*_test.py'),
]

apidoc.main(
[
'-o',
output_dir,
module_dir,
'--force',
'--separate',
'--module-first',
'--no-toc',
]
+ excludes
)


def setup(app):
app.connect('builder-inited', run_apidoc)
109 changes: 0 additions & 109 deletions docs/mobly.controllers.android_device_lib.rst

This file was deleted.

46 changes: 0 additions & 46 deletions docs/mobly.controllers.android_device_lib.services.rst

This file was deleted.

30 changes: 0 additions & 30 deletions docs/mobly.controllers.attenuator_lib.rst

This file was deleted.

63 changes: 0 additions & 63 deletions docs/mobly.controllers.rst

This file was deleted.

38 changes: 0 additions & 38 deletions docs/mobly.controllers.sniffer_lib.local.rst

This file was deleted.

17 changes: 0 additions & 17 deletions docs/mobly.controllers.sniffer_lib.rst

This file was deleted.

Loading
Loading