Skip to content
Merged
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
36 changes: 36 additions & 0 deletions doc/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=source
set BUILDDIR=build
set SPHINXPROJ=PackagingScientificPython

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
Empty file added doc/source/_static/.placeholder
Empty file.
31 changes: 31 additions & 0 deletions doc/source/api/diffpy.srfit.example_package.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.. _example_package documentation:

|title|
=======

.. |title| replace:: diffpy.srfit.example_package package

.. automodule:: diffpy.srfit.example_package
:members:
:undoc-members:
:show-inheritance:

|foo|
-----

.. |foo| replace:: diffpy.srfit.example_package.foo module

.. automodule:: diffpy.srfit.example_package.foo
:members:
:undoc-members:
:show-inheritance:

|bar|
-----

.. |bar| replace:: diffpy.srfit.example_package.bar module

.. automodule:: diffpy.srfit.example_package.foo
:members:
:undoc-members:
:show-inheritance:
30 changes: 30 additions & 0 deletions doc/source/api/diffpy.srfit.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
:tocdepth: -1

|title|
=======

.. |title| replace:: diffpy.srfit package

.. automodule:: diffpy.srfit
:members:
:undoc-members:
:show-inheritance:

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

.. toctree::
diffpy.srfit.example_package

Submodules
----------

|module|
--------

.. |module| replace:: diffpy.srfit.example_submodule module

.. automodule:: diffpy.srfit.example_submodule
:members:
:undoc-members:
:show-inheritance:
Loading