From ac8400aa6e60a233b409869ea6d4d4101609a7fa Mon Sep 17 00:00:00 2001 From: Grant Murphy Date: Mon, 27 Oct 2014 15:27:53 +1000 Subject: [PATCH] Removing this code. Needs to exist in a separate location to work with rtd.org --- docs/Makefile | 153 -------------------------------- docs/README.md | 10 --- docs/generate.sh | 6 -- docs/requirements.txt | 3 - docs/source/_static/.gitkeep | 0 docs/source/_templates/.gitkeep | 0 docs/source/advisories/.gitkeep | 0 docs/source/conf.py | 23 ----- docs/source/index.rst | 17 ---- docs/yaml2rst.py | 83 ----------------- 10 files changed, 295 deletions(-) delete mode 100644 docs/Makefile delete mode 100644 docs/README.md delete mode 100755 docs/generate.sh delete mode 100644 docs/requirements.txt delete mode 100644 docs/source/_static/.gitkeep delete mode 100644 docs/source/_templates/.gitkeep delete mode 100644 docs/source/advisories/.gitkeep delete mode 100644 docs/source/conf.py delete mode 100644 docs/source/index.rst delete mode 100644 docs/yaml2rst.py diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index b9afda7..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,153 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenStackSecurityAdvisories.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenStackSecurityAdvisories.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/OpenStackSecurityAdvisories" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenStackSecurityAdvisories" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 66f5c48..0000000 --- a/docs/README.md +++ /dev/null @@ -1,10 +0,0 @@ -Create readthedocs compatible documents from the YAML content. -Usage: -``` - $ virtualenv env - $ source env/bin/activate - $ pip install -r requirements.txt - $ ./generate.sh -``` - - diff --git a/docs/generate.sh b/docs/generate.sh deleted file mode 100755 index 36c8dee..0000000 --- a/docs/generate.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/bash -for file in ../*.yaml; do - output=`basename $file | sed -e 's/yaml/rst/'` - python yaml2rst.py $file > "./source/advisories/$output" -done -make html diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 4968426..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -PyYAML==3.11 -rstcloth==0.2.2 -wsgiref==0.1.2 diff --git a/docs/source/_static/.gitkeep b/docs/source/_static/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/source/_templates/.gitkeep b/docs/source/_templates/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/source/advisories/.gitkeep b/docs/source/advisories/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index b34e607..0000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,23 +0,0 @@ -# -*- coding: utf-8 -*- -import sys, os -extensions = [] -templates_path = ['_templates'] -source_suffix = '.rst' -master_doc = 'index' -project = u'OpenStack Security Advisories' -copyright = u'2014, Grant Murphy' -version = '0.1' -release = '0.1' -exclude_patterns = [] -pygments_style = 'sphinx' -html_theme = 'default' -html_show_copyright=False -html_show_sphinx=False -# local override rtd theme -if not os.environ.get('READTHEDOCS', None) == 'True': - import sphinx_rtd_theme - html_theme = 'sphinx_rtd_theme' - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - -html_static_path = ['_static'] -htmlhelp_basename = 'OpenStackSecurityAdvisoriesdoc' diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index bc6f58b..0000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -OpenStack Security Advisories -========================================================= - -Contents: - -.. toctree:: - :glob: - - ./advisories/* - - -Indices and tables -================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/docs/yaml2rst.py b/docs/yaml2rst.py deleted file mode 100644 index bd661f9..0000000 --- a/docs/yaml2rst.py +++ /dev/null @@ -1,83 +0,0 @@ -#!/usr/bin/env python -import yaml -from rstcloth import rstcloth -from datetime import datetime -from pprint import pprint -import sys -reload(sys) -sys.setdefaultencoding("utf-8") - -TW=3 - -def format_affected(affected): - content = "\n " # wtf? - seen = False - for product in affected: - if seen: - content += " "*TW - content +="- {product}: {version}\n".format(**product) - seen = True - content += "\n" - return content - -def format_reporters(reporters): - content = "" - seen = False - for reporter in reporters: - if seen: - content += " "*TW - if not 'affiliation' in reporter: - content += "- {name}\n".format(**reporter) - else: - content += "- {name} from {affiliation}\n".format(**reporter) - seen = True - - content += "\n" - return content - -def format_urls(links): - content ="" - seen = False - for link in links: - if seen: - content += " "*TW - content += "- `{url} <{url}>`_\n".format(url=link) - seen = True - content += "\n" - return content - -def main(args): - for arg in args: - data = yaml.safe_load(open(arg).read()) - doc = rstcloth.RstCloth() - doc.title("{id}".format(**data)) - doc.newline() - doc.h2(data['title']) - - doc.field('Date', "{:%B %d, %Y}".format(data['date'])) - doc.newline() - - doc.field('Description', data['description']) - doc.newline() - - doc.field('Announcement', doc.inline_link(data['reference'],data['reference']), wrap=False) - doc.newline() - - doc.field("Products affected", format_affected(data['affected-products']), wrap=False) - doc.newline() - - doc.field("Credits", format_reporters(data['reporters']), wrap=False) - doc.newline() - - doc.field("Bug reports", format_urls(data['issues']['links']), wrap=False) - doc.newline() - - doc.field("Reviews", format_urls(data['reviews']['links']), wrap=False) - doc.newline() - - #doc.directive('download', '`<{id}.yaml>`'.format(**data)) - doc.print_content() - -if __name__ == '__main__': - main(sys.argv[1:]) -