1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-01-31 02:01:16 +00:00

doc/config: Do not generate API documentation

On the latest version of Sphinx the way we were doing API generation
caused issues. Due to the structure/formatting of our code base the
output was not very useful anyway so remove the automatic generation
with the aim to manually document the relevant API in the future.
This commit is contained in:
Marc Bonnici 2018-05-14 10:50:32 +01:00 committed by setrofim
parent 087c18c752
commit 2a66e40d9b
4 changed files with 0 additions and 19 deletions

View File

@ -18,7 +18,6 @@ WAEXTOPTS = source/plugins ../wa ../wa/tests ../wa/framework
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
ALLSPHINXAPIOPTS = -f $(SPHINXAPIOPTS) -o source/api ../wa
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
@ -49,7 +48,6 @@ help:
clean:
rm -rf $(BUILDDIR)/*
rm -rf source/api/*
rm -rf source/plugins/*
rm -rf source/developer_reference/instrument_method_map.rst

View File

@ -1,7 +0,0 @@
API Reference
~~~~~~~~~~~~~
.. toctree::
:maxdepth: 5
api/wa

View File

@ -23,7 +23,6 @@
import sys
import os
import shlex
from sphinx.apidoc import main
this_dir = os.path.dirname(__file__)
sys.path.insert(0, os.path.join(this_dir, '..'))
@ -306,19 +305,11 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
def run_apidoc(_):
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
cur_dir = os.path.abspath(os.path.dirname(__file__))
api_output = os.path.join(cur_dir, 'api')
module = os.path.join(cur_dir, '..', '..', 'wa')
main(['-f', '-o', api_output, module, '--force'])
def setup(app):
module_dir = os.path.join('..', '..', 'wa')
excluded_extensions = [os.path.join(module_dir, 'framework'),
os.path.join(module_dir, 'tests')]
os.chdir(os.path.dirname(__file__))
app.connect('builder-inited', run_apidoc)
generate_plugin_documentation(module_dir, 'plugins', excluded_extensions)
generate_target_documentation('plugins')
generate_run_config_documentation('run_config')

View File

@ -80,7 +80,6 @@ References
:maxdepth: 2
plugins
api_reference
.. :ref:`FAQ <faq>`
.. ================