I've been trying to figure out how to create good docs for pyanaconda using Read the Docs, and have hit a dead end. RTD depends on the autodoc feature in Sphinx, but can't install anything other than python projects with a setup.py. You can mock various objects like I did in the previous pass at this, but that's fragile and still doesn't result in complete docs.
So, I propose that we generate the docs on a system with all the build deps installed or available via repos so that they are complete and nice looking, and that we carry the html output in the repo. This allows us to either server it up ourselves from someplace, or use gh-pages to serve it from github (which is what I suggest).
My understanding is you create a gh-pages branch for the project, then copy the html into the root of that branch (so it really isn't a branch, just a place to store the html for github). I'd suggest doing this manually so that the output can be checked for import problems.
From: "Brian C. Lane" bcl@redhat.com
And remove building docs from bumpver and scratch-bumpver. Building good docs for Anaconda is complicated by dependencies on other packages that Read the Docs cannot handle importing, and that are difficult to Mock.
Instead, manually run make -f Makefile.am html in the docs directory with the needed packages in the PYTHONPATH and then commit the resulting html files directly to the repository.
The packages either need to have recent enough versions installed on the build system, or point to newer ones with PYTHONPATH. Usually blivet, pykickstart and dnf:
cd docs PYTHONPATH=../../blivet/:../../pykickstart/:../../dnf/ make -f Makefile.am html
Adjust to point to wherever you have the correct projects checked out. --- Makefile.am | 6 +- docs/Makefile.am | 7 +- docs/conf.py | 17 +- docs/modules.rst | 7 - docs/pyanaconda.installclasses.rst | 30 --- docs/pyanaconda.isys.rst | 10 - docs/pyanaconda.packaging.rst | 54 ---- docs/pyanaconda.rst | 384 --------------------------- docs/pyanaconda.ui.categories.rst | 54 ---- docs/pyanaconda.ui.gui.hubs.rst | 30 --- docs/pyanaconda.ui.gui.rst | 46 ---- docs/pyanaconda.ui.gui.spokes.advstorage.rst | 46 ---- docs/pyanaconda.ui.gui.spokes.lib.rst | 102 ------- docs/pyanaconda.ui.gui.spokes.rst | 118 -------- docs/pyanaconda.ui.lib.rst | 38 --- docs/pyanaconda.ui.rst | 48 ---- docs/pyanaconda.ui.tui.hubs.rst | 22 -- docs/pyanaconda.ui.tui.rst | 31 --- docs/pyanaconda.ui.tui.simpleline.rst | 30 --- docs/pyanaconda.ui.tui.spokes.rst | 110 -------- 20 files changed, 16 insertions(+), 1174 deletions(-) delete mode 100644 docs/modules.rst delete mode 100644 docs/pyanaconda.installclasses.rst delete mode 100644 docs/pyanaconda.isys.rst delete mode 100644 docs/pyanaconda.packaging.rst delete mode 100644 docs/pyanaconda.rst delete mode 100644 docs/pyanaconda.ui.categories.rst delete mode 100644 docs/pyanaconda.ui.gui.hubs.rst delete mode 100644 docs/pyanaconda.ui.gui.rst delete mode 100644 docs/pyanaconda.ui.gui.spokes.advstorage.rst delete mode 100644 docs/pyanaconda.ui.gui.spokes.lib.rst delete mode 100644 docs/pyanaconda.ui.gui.spokes.rst delete mode 100644 docs/pyanaconda.ui.lib.rst delete mode 100644 docs/pyanaconda.ui.rst delete mode 100644 docs/pyanaconda.ui.tui.hubs.rst delete mode 100644 docs/pyanaconda.ui.tui.rst delete mode 100644 docs/pyanaconda.ui.tui.simpleline.rst delete mode 100644 docs/pyanaconda.ui.tui.spokes.rst
diff --git a/Makefile.am b/Makefile.am index 9d6a7e0..47aeeb1 100644 --- a/Makefile.am +++ b/Makefile.am @@ -81,8 +81,7 @@ scratch-bumpver: po-empty opts="$${opts} -d" ; \ fi ; \ ( cd $(srcdir) && scripts/makebumpver --skip-zanata $${opts} ) || exit 1 ; \ - $(MAKE) -C po $(PACKAGE_NAME).pot-update ; \ - $(MAKE) -C docs apidoc + $(MAKE) -C po $(PACKAGE_NAME).pot-update
release: $(MAKE) dist && $(MAKE) tag && git checkout -- $(srcdir)/po/$(PACKAGE_NAME).pot @@ -108,8 +107,7 @@ bumpver: po-pull fi ; \ ( cd $(srcdir) && scripts/makebumpver $${opts} ) || exit 1 ; \ $(MAKE) -C po $(PACKAGE_NAME).pot-update && \ - zanata push $(ZANATA_PUSH_ARGS) ; \ - $(MAKE) -C docs apidoc + zanata push $(ZANATA_PUSH_ARGS)
# Install all packages specified as BuildRequires in the Anaconda specfile # -> installs packages needed to build Anaconda diff --git a/docs/Makefile.am b/docs/Makefile.am index 0c8a942..a8ea674 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -33,14 +33,14 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build SPHINXAPIDOC = sphinx-apidoc PAPER = -BUILDDIR = _build +BUILDDIR = . SOURCEDIR = ../pyanaconda MODULE_NAMES = modules.rst pyanaconda.*rst
# Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
@@ -68,9 +68,6 @@ help: @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)"
-clean: - -rm -rf $(BUILDDIR)/* - # rebuild the api *rst files if SPHINXAPIDOC is available. apidoc: if [ -f /usr/bin/$(SPHINXAPIDOC) ]; then \ diff --git a/docs/conf.py b/docs/conf.py index 5bac3ee..52394da 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -75,7 +75,7 @@ def read_version():
# List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = ['_build', 'html']
# The reST default role (used for this markup: `text`) to use for all documents. #default_role = None @@ -301,6 +301,16 @@ def read_version(): # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/2': None}
+# on_rtd is whether we are on readthedocs.org +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# otherwise, readthedocs.org uses their theme by default, so no need to specify it + # This was taken directly from here: # http://read-the-docs.readthedocs.org/en/latest/faq.html#i-get-import-errors-... # I only added the __getitem__ method. @@ -332,9 +342,6 @@ def __getattr__(cls, name): def __getitem__(cls, key): return cls.__getattr__(key)
-MOCK_MODULES = ['_isys', 'pyudev', 'blivet', 'blivet.arch', 'blivet.deviceaction', - 'blivet.partspec', 'gi.repository', 'langtable', 'libuser', 'meh', - 'ntplib', 'pykickstart.base', 'pykickstart.constants', 'pykickstart.sections', - 'pytz', 'requests', 'selinux', 'snack'] +MOCK_MODULES = ['_isys'] for mod_name in MOCK_MODULES: sys.modules[mod_name] = Mock() diff --git a/docs/modules.rst b/docs/modules.rst deleted file mode 100644 index 9f5446c..0000000 --- a/docs/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -pyanaconda -========== - -.. toctree:: - :maxdepth: 4 - - pyanaconda diff --git a/docs/pyanaconda.installclasses.rst b/docs/pyanaconda.installclasses.rst deleted file mode 100644 index 6fc4911..0000000 --- a/docs/pyanaconda.installclasses.rst +++ /dev/null @@ -1,30 +0,0 @@ -pyanaconda.installclasses package -================================= - -Submodules ----------- - -pyanaconda.installclasses.fedora module ---------------------------------------- - -.. automodule:: pyanaconda.installclasses.fedora - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.installclasses.rhel module -------------------------------------- - -.. automodule:: pyanaconda.installclasses.rhel - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.installclasses - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.isys.rst b/docs/pyanaconda.isys.rst deleted file mode 100644 index 0a7bb24..0000000 --- a/docs/pyanaconda.isys.rst +++ /dev/null @@ -1,10 +0,0 @@ -pyanaconda.isys package -======================= - -Module contents ---------------- - -.. automodule:: pyanaconda.isys - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.packaging.rst b/docs/pyanaconda.packaging.rst deleted file mode 100644 index ef017cc..0000000 --- a/docs/pyanaconda.packaging.rst +++ /dev/null @@ -1,54 +0,0 @@ -pyanaconda.packaging package -============================ - -Submodules ----------- - -pyanaconda.packaging.dnfpayload module --------------------------------------- - -.. automodule:: pyanaconda.packaging.dnfpayload - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.packaging.livepayload module ---------------------------------------- - -.. automodule:: pyanaconda.packaging.livepayload - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.packaging.rpmostreepayload module --------------------------------------------- - -.. automodule:: pyanaconda.packaging.rpmostreepayload - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.packaging.tarpayload module --------------------------------------- - -.. automodule:: pyanaconda.packaging.tarpayload - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.packaging.yumpayload module --------------------------------------- - -.. automodule:: pyanaconda.packaging.yumpayload - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.packaging - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.rst b/docs/pyanaconda.rst deleted file mode 100644 index 8d6c851..0000000 --- a/docs/pyanaconda.rst +++ /dev/null @@ -1,384 +0,0 @@ -pyanaconda package -================== - -Subpackages ------------ - -.. toctree:: - - pyanaconda.installclasses - pyanaconda.isys - pyanaconda.packaging - pyanaconda.ui - -Submodules ----------- - -pyanaconda.addons module ------------------------- - -.. automodule:: pyanaconda.addons - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.anaconda module --------------------------- - -.. automodule:: pyanaconda.anaconda - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.anaconda_argparse module ------------------------------------ - -.. automodule:: pyanaconda.anaconda_argparse - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.anaconda_log module ------------------------------- - -.. automodule:: pyanaconda.anaconda_log - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.bootloader module ----------------------------- - -.. automodule:: pyanaconda.bootloader - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.constants module ---------------------------- - -.. automodule:: pyanaconda.constants - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.constants_text module --------------------------------- - -.. automodule:: pyanaconda.constants_text - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.desktop module -------------------------- - -.. automodule:: pyanaconda.desktop - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.errors module ------------------------- - -.. automodule:: pyanaconda.errors - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.exception module ---------------------------- - -.. automodule:: pyanaconda.exception - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.flags module ------------------------ - -.. automodule:: pyanaconda.flags - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.geoloc module ------------------------- - -.. automodule:: pyanaconda.geoloc - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.i18n module ----------------------- - -.. automodule:: pyanaconda.i18n - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ihelp module ------------------------ - -.. automodule:: pyanaconda.ihelp - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.image module ------------------------ - -.. automodule:: pyanaconda.image - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.install module -------------------------- - -.. automodule:: pyanaconda.install - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.installclass module ------------------------------- - -.. automodule:: pyanaconda.installclass - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.installinterfacebase module --------------------------------------- - -.. automodule:: pyanaconda.installinterfacebase - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.iutil module ------------------------ - -.. automodule:: pyanaconda.iutil - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.kexec module ------------------------ - -.. automodule:: pyanaconda.kexec - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.keyboard module --------------------------- - -.. automodule:: pyanaconda.keyboard - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.kickstart module ---------------------------- - -.. automodule:: pyanaconda.kickstart - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.localization module ------------------------------- - -.. automodule:: pyanaconda.localization - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.network module -------------------------- - -.. automodule:: pyanaconda.network - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.nm module --------------------- - -.. automodule:: pyanaconda.nm - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ntp module ---------------------- - -.. automodule:: pyanaconda.ntp - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.orderedset module ----------------------------- - -.. automodule:: pyanaconda.orderedset - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.product module -------------------------- - -.. automodule:: pyanaconda.product - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.progress module --------------------------- - -.. automodule:: pyanaconda.progress - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.pwpolicy module --------------------------- - -.. automodule:: pyanaconda.pwpolicy - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.queuefactory module ------------------------------- - -.. automodule:: pyanaconda.queuefactory - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.regexes module -------------------------- - -.. automodule:: pyanaconda.regexes - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.rescue module ------------------------- - -.. automodule:: pyanaconda.rescue - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.safe_dbus module ---------------------------- - -.. automodule:: pyanaconda.safe_dbus - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.screensaver module ------------------------------ - -.. automodule:: pyanaconda.screensaver - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.simpleconfig module ------------------------------- - -.. automodule:: pyanaconda.simpleconfig - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.sitecustomize module -------------------------------- - -.. automodule:: pyanaconda.sitecustomize - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.startup_utils module -------------------------------- - -.. automodule:: pyanaconda.startup_utils - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.storage_utils module -------------------------------- - -.. automodule:: pyanaconda.storage_utils - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.text module ----------------------- - -.. automodule:: pyanaconda.text - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.threads module -------------------------- - -.. automodule:: pyanaconda.threads - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.timezone module --------------------------- - -.. automodule:: pyanaconda.timezone - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.users module ------------------------ - -.. automodule:: pyanaconda.users - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.version module -------------------------- - -.. automodule:: pyanaconda.version - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.vnc module ---------------------- - -.. automodule:: pyanaconda.vnc - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.ui.categories.rst b/docs/pyanaconda.ui.categories.rst deleted file mode 100644 index 74d6beb..0000000 --- a/docs/pyanaconda.ui.categories.rst +++ /dev/null @@ -1,54 +0,0 @@ -pyanaconda.ui.categories package -================================ - -Submodules ----------- - -pyanaconda.ui.categories.customization module ---------------------------------------------- - -.. automodule:: pyanaconda.ui.categories.customization - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.categories.localization module --------------------------------------------- - -.. automodule:: pyanaconda.ui.categories.localization - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.categories.software module ----------------------------------------- - -.. automodule:: pyanaconda.ui.categories.software - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.categories.system module --------------------------------------- - -.. automodule:: pyanaconda.ui.categories.system - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.categories.user_settings module ---------------------------------------------- - -.. automodule:: pyanaconda.ui.categories.user_settings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.ui.categories - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.ui.gui.hubs.rst b/docs/pyanaconda.ui.gui.hubs.rst deleted file mode 100644 index f71f293..0000000 --- a/docs/pyanaconda.ui.gui.hubs.rst +++ /dev/null @@ -1,30 +0,0 @@ -pyanaconda.ui.gui.hubs package -============================== - -Submodules ----------- - -pyanaconda.ui.gui.hubs.progress module --------------------------------------- - -.. automodule:: pyanaconda.ui.gui.hubs.progress - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.hubs.summary module -------------------------------------- - -.. automodule:: pyanaconda.ui.gui.hubs.summary - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.ui.gui.hubs - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.ui.gui.rst b/docs/pyanaconda.ui.gui.rst deleted file mode 100644 index 850d1b6..0000000 --- a/docs/pyanaconda.ui.gui.rst +++ /dev/null @@ -1,46 +0,0 @@ -pyanaconda.ui.gui package -========================= - -Subpackages ------------ - -.. toctree:: - - pyanaconda.ui.gui.hubs - pyanaconda.ui.gui.spokes - -Submodules ----------- - -pyanaconda.ui.gui.helpers module --------------------------------- - -.. automodule:: pyanaconda.ui.gui.helpers - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.utils module ------------------------------- - -.. automodule:: pyanaconda.ui.gui.utils - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.xkl_wrapper module ------------------------------------- - -.. automodule:: pyanaconda.ui.gui.xkl_wrapper - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.ui.gui - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.ui.gui.spokes.advstorage.rst b/docs/pyanaconda.ui.gui.spokes.advstorage.rst deleted file mode 100644 index 7bc0881..0000000 --- a/docs/pyanaconda.ui.gui.spokes.advstorage.rst +++ /dev/null @@ -1,46 +0,0 @@ -pyanaconda.ui.gui.spokes.advstorage package -=========================================== - -Submodules ----------- - -pyanaconda.ui.gui.spokes.advstorage.dasd module ------------------------------------------------ - -.. automodule:: pyanaconda.ui.gui.spokes.advstorage.dasd - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.advstorage.fcoe module ------------------------------------------------ - -.. automodule:: pyanaconda.ui.gui.spokes.advstorage.fcoe - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.advstorage.iscsi module ------------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.advstorage.iscsi - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.advstorage.zfcp module ------------------------------------------------ - -.. automodule:: pyanaconda.ui.gui.spokes.advstorage.zfcp - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.ui.gui.spokes.advstorage - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.ui.gui.spokes.lib.rst b/docs/pyanaconda.ui.gui.spokes.lib.rst deleted file mode 100644 index 9069ae2..0000000 --- a/docs/pyanaconda.ui.gui.spokes.lib.rst +++ /dev/null @@ -1,102 +0,0 @@ -pyanaconda.ui.gui.spokes.lib package -==================================== - -Submodules ----------- - -pyanaconda.ui.gui.spokes.lib.accordion module ---------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.lib.accordion - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.lib.cart module ----------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.lib.cart - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.lib.custom_storage_helpers module ----------------------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.lib.custom_storage_helpers - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.lib.dasdfmt module -------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.lib.dasdfmt - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.lib.detailederror module -------------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.lib.detailederror - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.lib.entropy_dialog module --------------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.lib.entropy_dialog - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.lib.lang_locale_handler module -------------------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.lib.lang_locale_handler - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.lib.passphrase module ----------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.lib.passphrase - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.lib.refresh module -------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.lib.refresh - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.lib.resize module ------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.lib.resize - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.lib.summary module -------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.lib.summary - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.ui.gui.spokes.lib - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.ui.gui.spokes.rst b/docs/pyanaconda.ui.gui.spokes.rst deleted file mode 100644 index be41beb..0000000 --- a/docs/pyanaconda.ui.gui.spokes.rst +++ /dev/null @@ -1,118 +0,0 @@ -pyanaconda.ui.gui.spokes package -================================ - -Subpackages ------------ - -.. toctree:: - - pyanaconda.ui.gui.spokes.advstorage - pyanaconda.ui.gui.spokes.lib - -Submodules ----------- - -pyanaconda.ui.gui.spokes.custom module --------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.custom - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.datetime_spoke module ----------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.datetime_spoke - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.filter module --------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.filter - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.keyboard module ----------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.keyboard - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.langsupport module -------------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.langsupport - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.network module ---------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.network - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.password module ----------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.password - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.software module ----------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.software - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.source module --------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.source - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.storage module ---------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.storage - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.user module ------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.user - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.gui.spokes.welcome module ---------------------------------------- - -.. automodule:: pyanaconda.ui.gui.spokes.welcome - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.ui.gui.spokes - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.ui.lib.rst b/docs/pyanaconda.ui.lib.rst deleted file mode 100644 index 3936ea1..0000000 --- a/docs/pyanaconda.ui.lib.rst +++ /dev/null @@ -1,38 +0,0 @@ -pyanaconda.ui.lib package -========================= - -Submodules ----------- - -pyanaconda.ui.lib.disks module ------------------------------- - -.. automodule:: pyanaconda.ui.lib.disks - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.lib.entropy module --------------------------------- - -.. automodule:: pyanaconda.ui.lib.entropy - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.lib.space module ------------------------------- - -.. automodule:: pyanaconda.ui.lib.space - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.ui.lib - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.ui.rst b/docs/pyanaconda.ui.rst deleted file mode 100644 index 0e14665..0000000 --- a/docs/pyanaconda.ui.rst +++ /dev/null @@ -1,48 +0,0 @@ -pyanaconda.ui package -===================== - -Subpackages ------------ - -.. toctree:: - - pyanaconda.ui.categories - pyanaconda.ui.gui - pyanaconda.ui.lib - pyanaconda.ui.tui - -Submodules ----------- - -pyanaconda.ui.common module ---------------------------- - -.. automodule:: pyanaconda.ui.common - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.communication module ----------------------------------- - -.. automodule:: pyanaconda.ui.communication - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.helpers module ----------------------------- - -.. automodule:: pyanaconda.ui.helpers - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.ui - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.ui.tui.hubs.rst b/docs/pyanaconda.ui.tui.hubs.rst deleted file mode 100644 index 9a6f474..0000000 --- a/docs/pyanaconda.ui.tui.hubs.rst +++ /dev/null @@ -1,22 +0,0 @@ -pyanaconda.ui.tui.hubs package -============================== - -Submodules ----------- - -pyanaconda.ui.tui.hubs.summary module -------------------------------------- - -.. automodule:: pyanaconda.ui.tui.hubs.summary - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.ui.tui.hubs - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.ui.tui.rst b/docs/pyanaconda.ui.tui.rst deleted file mode 100644 index 578b53b..0000000 --- a/docs/pyanaconda.ui.tui.rst +++ /dev/null @@ -1,31 +0,0 @@ -pyanaconda.ui.tui package -========================= - -Subpackages ------------ - -.. toctree:: - - pyanaconda.ui.tui.hubs - pyanaconda.ui.tui.simpleline - pyanaconda.ui.tui.spokes - -Submodules ----------- - -pyanaconda.ui.tui.tuiobject module ----------------------------------- - -.. automodule:: pyanaconda.ui.tui.tuiobject - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.ui.tui - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.ui.tui.simpleline.rst b/docs/pyanaconda.ui.tui.simpleline.rst deleted file mode 100644 index bcafb7b..0000000 --- a/docs/pyanaconda.ui.tui.simpleline.rst +++ /dev/null @@ -1,30 +0,0 @@ -pyanaconda.ui.tui.simpleline package -==================================== - -Submodules ----------- - -pyanaconda.ui.tui.simpleline.base module ----------------------------------------- - -.. automodule:: pyanaconda.ui.tui.simpleline.base - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.tui.simpleline.widgets module -------------------------------------------- - -.. automodule:: pyanaconda.ui.tui.simpleline.widgets - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.ui.tui.simpleline - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/pyanaconda.ui.tui.spokes.rst b/docs/pyanaconda.ui.tui.spokes.rst deleted file mode 100644 index 49a1f25..0000000 --- a/docs/pyanaconda.ui.tui.spokes.rst +++ /dev/null @@ -1,110 +0,0 @@ -pyanaconda.ui.tui.spokes package -================================ - -Submodules ----------- - -pyanaconda.ui.tui.spokes.askvnc module --------------------------------------- - -.. automodule:: pyanaconda.ui.tui.spokes.askvnc - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.tui.spokes.langsupport module -------------------------------------------- - -.. automodule:: pyanaconda.ui.tui.spokes.langsupport - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.tui.spokes.network module ---------------------------------------- - -.. automodule:: pyanaconda.ui.tui.spokes.network - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.tui.spokes.password module ----------------------------------------- - -.. automodule:: pyanaconda.ui.tui.spokes.password - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.tui.spokes.progress module ----------------------------------------- - -.. automodule:: pyanaconda.ui.tui.spokes.progress - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.tui.spokes.shell_spoke module -------------------------------------------- - -.. automodule:: pyanaconda.ui.tui.spokes.shell_spoke - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.tui.spokes.software module ----------------------------------------- - -.. automodule:: pyanaconda.ui.tui.spokes.software - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.tui.spokes.source module --------------------------------------- - -.. automodule:: pyanaconda.ui.tui.spokes.source - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.tui.spokes.storage module ---------------------------------------- - -.. automodule:: pyanaconda.ui.tui.spokes.storage - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.tui.spokes.time_spoke module ------------------------------------------- - -.. automodule:: pyanaconda.ui.tui.spokes.time_spoke - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.tui.spokes.user module ------------------------------------- - -.. automodule:: pyanaconda.ui.tui.spokes.user - :members: - :undoc-members: - :show-inheritance: - -pyanaconda.ui.tui.spokes.warnings module ----------------------------------------- - -.. automodule:: pyanaconda.ui.tui.spokes.warnings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyanaconda.ui.tui.spokes - :members: - :undoc-members: - :show-inheritance:
Here's what the docs look like: https://bcl.fedorapeople.org/anaconda-docs/
anaconda-patches@lists.fedorahosted.org