diff --git a/doc/source/api/diffpy.pdffit2.rst b/doc/source/api/diffpy.pdffit2.rst index cd474770..759fb63c 100644 --- a/doc/source/api/diffpy.pdffit2.rst +++ b/doc/source/api/diffpy.pdffit2.rst @@ -8,26 +8,29 @@ diffpy.pdffit2 package :undoc-members: :show-inheritance: -diffpy.pdffit2.ipy_ext module ------------------------------ +Submodules +---------- -.. automodule:: diffpy.pdffit2.ipy_ext +diffpy.pdffit2.output module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.pdffit2.output :members: :undoc-members: :show-inheritance: diffpy.pdffit2.pdffit module ------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.pdffit2.pdffit :members: :undoc-members: :show-inheritance: -diffpy.pdffit2.output module ------------------------------ +diffpy.pdffit2.ipy_ext module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.pdffit2.output +.. automodule:: diffpy.pdffit2.ipy_ext :members: :undoc-members: :show-inheritance: diff --git a/doc/source/conf.py b/doc/source/conf.py index e5e8dace..c15e8639 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -18,9 +18,6 @@ from importlib.metadata import version from pathlib import Path -# Eliminate autodoc warning -autodoc_mock_imports = ["diffpy.pdffit2"] - # 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 Path().resolve() to make it absolute, like shown here. diff --git a/doc/source/epydoc/Makefile b/doc/source/epydoc/Makefile deleted file mode 100644 index 756095f5..00000000 --- a/doc/source/epydoc/Makefile +++ /dev/null @@ -1,17 +0,0 @@ -PKGNAME = diffpy.pdffit2 -OUTPUT = html -WEBDOCDIR = login.cacr.caltech.edu:/cacr/home/proj/danse/docs.danse.us/docroot/diffraction - - -all: - epydoc --config=epydoc.cfg --output=$(OUTPUT) \ - --name=$(PKGNAME) $(PKGNAME) - - -clean: - /bin/rm -rf $(OUTPUT) - - -publish: - rsync -e /usr/bin/ssh -va --chmod=a+rwx,o-w,Dg+s,Fa-x \ - $(OUTPUT)/ $(WEBDOCDIR)/$(PKGNAME) diff --git a/doc/source/epydoc/epydoc.cfg b/doc/source/epydoc/epydoc.cfg deleted file mode 100644 index dddbcd90..00000000 --- a/doc/source/epydoc/epydoc.cfg +++ /dev/null @@ -1,54 +0,0 @@ -[epydoc] - -# docformat -# The default markup language for docstrings, for modules that do -# not define __docformat__. Defaults to epytext. -docformat: plaintext - -# The type of output that should be generated. Should be one -# of: html, text, latex, dvi, ps, pdf. -output: html - -# An integer indicating how verbose epydoc should be. The default -# value is 0; negative values will supress warnings and errors; -# positive values will give more verbose output. -verbosity: 0 - -# A boolean value indicating that Epydoc should show a tracaback -# in case of unexpected error. By default don't show tracebacks -debug: 0 - -# If True, don't try to use colors or cursor control when doing -# textual output. The default False assumes a rich text prompt -simple-term: 1 - -# The format for showing inheritance objects. -# It should be one of: 'grouped', 'listed', 'included'. -inheritance: grouped - -# Whether or not to inclue private variables. (Even if included, -# private variables will be hidden by default.) -private: yes - -# Whether or not to list each module's imports. -imports: yes - -# Whether or not to include syntax highlighted source code in -# the output (HTML only). -sourcecode: yes - -# Whether or not to includea a page with Epydoc log, containing -# effective option at the time of generation and the reported logs. -include-log: no - -### Output options - -# The documented project's name. -#name: diffpy.FIXME - -# The CSS stylesheet for HTML output. Can be the name of a builtin -# stylesheet, or the name of a file. -css: white - -# The documented project's URL. -url: http://www.diffpy.org/