diff --git a/doc/sphinx/README.md b/doc/sphinx/README.md new file mode 100644 index 0000000..2ec8323 --- /dev/null +++ b/doc/sphinx/README.md @@ -0,0 +1,5 @@ +To build the documentation in this directory, + + sphinx-build . _build_html + +The output will be saved as html in `_build_html/`. diff --git a/doc/sphinx/changes.rst b/doc/sphinx/changes.rst index 3632a7d..c224e64 100644 --- a/doc/sphinx/changes.rst +++ b/doc/sphinx/changes.rst @@ -1,4 +1,4 @@ Changes in IOR -***************** +************** -.. .. include:: ../../ChangeLog +.. .. include:: ../../NEWS diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index 90628fd..688303e 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -64,9 +64,9 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'IOR' -copyright = u'2017, IOR' -author = u'IOR' +project = u'ior' +copyright = u'2018, The Regents of the University of California' +author = u'The IOR Developer Community' # The version info for the project you're documenting, acts as replacement for @@ -197,7 +197,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'IOR', u'IOR Documentation', - author, 'IOR', 'One line description of project.', + author, 'IOR', 'IOR/mdtest Parallel I/O Benchmarks', 'Miscellaneous'), ]