From 2ca46832190c2651ef8aaaebf68f752ced851f86 Mon Sep 17 00:00:00 2001 From: Robert Putt Date: Tue, 15 May 2018 19:55:22 +0100 Subject: [PATCH] Add basics to Sphinx doc folder to get some docs started. Adds basic stuff like a requirements.txt to the doc folder so we can get started with some documentation! Change-Id: I1114f38fe8bf28d5414e73fd67b9acf3a883e139 --- README.rst | 12 ++---------- doc/source/about.rst | 5 +++++ doc/source/index.rst | 5 +++-- doc/source/installation.rst | 9 ++++----- doc/source/plugins.rst | 12 ++++++++++++ doc/source/readme.rst | 1 - doc/source/usage.rst | 6 +++--- requirements.txt | 18 +++++++++--------- test-requirements.txt | 18 +++++++++--------- 9 files changed, 47 insertions(+), 39 deletions(-) create mode 100644 doc/source/about.rst create mode 100644 doc/source/plugins.rst delete mode 100644 doc/source/readme.rst diff --git a/README.rst b/README.rst index a9855c0..e7127c2 100644 --- a/README.rst +++ b/README.rst @@ -1,18 +1,10 @@ =============================== -nemesis +Nemesis =============================== -A file intelligence and malware scanning API for the OpenStack ecosystem. - -Please fill here a long description which must be at least 3 lines wrapped on -80 cols, so that distribution package maintainers can use it in their packages. -Note that this is a hard requirement. +Nemesis provides a pluggable file intelligence API for the OpenStack ecosystem. * Free software: Apache license * Source: http://git.openstack.org/cgit/openstack/nemesis * Bugs: http://bugs.launchpad.net/python-nemesis -Features --------- - -* TODO diff --git a/doc/source/about.rst b/doc/source/about.rst new file mode 100644 index 0000000..d27c1d1 --- /dev/null +++ b/doc/source/about.rst @@ -0,0 +1,5 @@ +=============== +About Nemesis +=============== + +This needs fleshing out still. diff --git a/doc/source/index.rst b/doc/source/index.rst index 8e6633c..168e2cd 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to nemesis's documentation! +Welcome to Nemesis' documentation! ======================================================== Contents: @@ -11,9 +11,10 @@ Contents: .. toctree:: :maxdepth: 2 - readme + about installation usage + plugins contributing Indices and tables diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 046d1ba..bf06238 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -2,11 +2,10 @@ Installation ============ -At the command line:: +API Nodes +--------- - $ pip install nemesis -Or, if you have virtualenvwrapper installed:: - $ mkvirtualenv nemesis - $ pip install nemesis +Worker Nodes +------------ diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst new file mode 100644 index 0000000..55be68a --- /dev/null +++ b/doc/source/plugins.rst @@ -0,0 +1,12 @@ +================ +Plugins +================ + +ClamAV +------ +Allows malware scanning via ClamD. + +EXIF +---- +Extracts EXIF data from compatible image files. + diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/doc/source/usage.rst b/doc/source/usage.rst index e91eb6c..52ddb0c 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -1,6 +1,6 @@ -======== -Usage -======== +================== +Raw API Usage +================== To use nemesis in a project:: diff --git a/requirements.txt b/requirements.txt index 220f878..88907c7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,15 +2,15 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -pbr!=2.1.0,>=2.0.0 # Apache-2.0 -alembic>=0.8.10 # MIT -Flask!=0.11,<1.0,>=0.10 # BSD -Flask-SQLAlchemy>=2.0 # BSD +pbr!=2.1.0,>=3.1.1 # Apache-2.0 +alembic>=0.9.8 # MIT +Flask!=0.11,<1.0,>=0.12.2 # BSD +Flask-SQLAlchemy>=2.3.2 # BSD flask-oslolog>=0.1 # Apache-2.0 flask-keystone>=0.2 # Apache-2.0 oslo.config>=5.2.0 # Apache-2.0 -oslo.messaging>=5.29.0 # Apache-2.0 -oslo.log>=3.36.0 # Apache-2.0 -python-swiftclient>=3.2.0 # Apache-2.0 -keystonemiddleware>=4.17.0 # Apache-2.0 -python-magic>=0.4.13 # MIT +oslo.messaging>=5.36.0 # Apache-2.0 +oslo.log>=3.37.0 # Apache-2.0 +python-swiftclient>=3.5.0 # Apache-2.0 +keystonemiddleware>=4.21.0 # Apache-2.0 +python-magic>=0.4.15 # MIT diff --git a/test-requirements.txt b/test-requirements.txt index 9a608cb..134f9ed 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -4,14 +4,14 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 -coverage!=4.4,>=4.0 # Apache-2.0 -python-subunit>=1.0.0 # Apache-2.0/BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD -oslosphinx>=4.7.0 # Apache-2.0 -oslotest>=3.2.0 # Apache-2.0 -testrepository>=0.0.18 # Apache-2.0/BSD -testscenarios>=0.4 # Apache-2.0/BSD -testtools>=2.2.0 # MIT +coverage>=4.5.1 # Apache-2.0 +python-subunit>=1.2.0 # Apache-2.0/BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD +oslosphinx>=4.18.0 # Apache-2.0 +oslotest>=3.3.0 # Apache-2.0 +testrepository>=0.0.20 # Apache-2.0/BSD +testscenarios>=0.5.0 # Apache-2.0/BSD +testtools>=2.3.0 # MIT # releasenotes -reno>=2.5.0 # Apache-2.0 +reno>=2.7.0 # Apache-2.0