Browse Source

Rework repository to make it an installable python package

This is an overhaul of the complete content to make it
a separate python package that can be installed on the jenkins
machines as well as on editor's machines.

The goal of this patchset is to package everything
and get the command "openstack-doc-test" running so that
it can be used for gating.

This will need further refinement for the other commands.

Change-Id: Icc2f1807dd5ab5fb2f83c05d1b3895b3a9a0dbaf
changes/84/61684/3
Andreas Jaeger 7 years ago
parent
commit
05f9428303
11 changed files with 131 additions and 48 deletions
  1. +5
    -0
      .gitignore
  2. +10
    -0
      MANIFEST.in
  3. +2
    -2
      autogenerate-config-docs/common.py
  4. +0
    -0
      bin/build-ha-guide.sh
  5. +0
    -0
      bin/generatedocbook
  6. +0
    -0
      bin/generatepot
  7. +0
    -0
      os_doc_tools/__init__.py
  8. +47
    -46
      os_doc_tools/doctest.py
  9. +5
    -0
      requirements.txt
  10. +40
    -0
      setup.cfg
  11. +22
    -0
      setup.py

+ 5
- 0
.gitignore View File

@ -2,3 +2,8 @@
.bak
*.swp
*~
AUTHORS
ChangeLog
build
dist
openstack_doc_tools.egg-info

+ 10
- 0
MANIFEST.in View File

@ -0,0 +1,10 @@
include README.rst
include AUTHORS
include LICENSE
include ChangeLog
recursive-include doc *
recursive-include tools *
recursive-include sitemap *
exclude .gitignore
exclude .gitreview

+ 2
- 2
autogenerate-config-docs/common.py View File

@ -2,15 +2,15 @@
# A collection of shared functions for managing help flag mapping files.
#
from oslo.config import cfg
import os
import string
import sys
import pkgutil
import glob
from collections import defaultdict
from xml.sax.saxutils import escape
from oslo.config import cfg
# gettext internationalisation function requisite:
import __builtin__


build-ha-guide.sh → bin/build-ha-guide.sh View File


generatedocbook → bin/generatedocbook View File


generatepot → bin/generatepot View File


+ 0
- 0
os_doc_tools/__init__.py View File


test.py → os_doc_tools/doctest.py View File


+ 5
- 0
requirements.txt View File

@ -0,0 +1,5 @@
pbr>=0.5.21,<1.0
argparse
lxml>=2.3
oslo.config

+ 40
- 0
setup.cfg View File

@ -0,0 +1,40 @@
[metadata]
name = openstack-doc-tools
version = 0.1
summary = Tools for OpenStack Documentation
description-file =
README.rst
author = OpenStack Documentation
author-email = openstack-doc@lists.openstack.org
home-page = http://www.openstack.org/
classifier =
Environment :: OpenStack
Intended Audience :: Information Technology
Intended Audience :: System Administrators
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
Programming Language :: Python
Programming Language :: Python :: 2
Programming Language :: Python :: 2.7
Programming Language :: Python :: 2.6
[files]
packages =
os_doc_tools
autogenerate-config-docs
scripts =
bin/build-ha-guide.sh
bin/generatedocbook
bin/generatepot
data_files =
usr/share/openstack-doc-tools/sitemap = sitemap/*
usr/share/openstack-doc-tools/cleanup = cleanup/*
[global]
setup-hooks =
pbr.hooks.setup_hook
[entry_points]
console_scripts =
openstack-doc-test = os_doc_tools.doctest:main
openstack-autohelp = autohelp:main

+ 22
- 0
setup.py View File

@ -0,0 +1,22 @@
#!/usr/bin/env python
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
import setuptools
setuptools.setup(
setup_requires=['pbr'],
pbr=True)

Loading…
Cancel
Save