diff --git a/docs/source/documentation.rst b/docs/source/documentation.rst new file mode 100644 index 0000000..929eae9 --- /dev/null +++ b/docs/source/documentation.rst @@ -0,0 +1,13 @@ +Building the documentation +========================= + +This documentation uses `Sphinx `_ + +It can be built in different formats. + +Run ``cd docs; make`` to see the possible formats. + +Run ``cd docs; make html`` to build the documentation in HTML format. + +You can see the generated HTML documentation in a browser opening the directory +`docs/build/html`. diff --git a/docs/source/index.rst b/docs/source/index.rst index 477527b..f9b4955 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,6 +12,7 @@ Welcome to pEpPythonAdapter's documentation! install testing + documentation software_using api/pEp