Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cyprieng authored and cyprien-g committed Jan 29, 2016
1 parent 5d05e2f commit c8cd182
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 31 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ deploy:
distributions: sdist bdist_wheel
user: cyprieng
password:
secure: XITH5fCPmchCp8C2DHaQJYZfsgDSLnicVpZ7EYW/hh+UHvwTwtk/ueAypi38wt0lzciL61t2Z2YPTjQJchOtUGPGQ3FwMiqMHS4+W0H2aj45jPWttJ3yqvP7k9eEqjUeDJHUX8J3HK6JkofFnVJjxCiUUmsP30U7tF1oWqcHoI/fUlH0H6rJJLT0So/1q1BqWnxtvxhPcUsiV6R1A6Eo/tBu84NtIBZfTtcFVyUEWhgCGhJFnN0Gcm1irWiO5bWSA0AJz/YhRujVzssp7ccVZExxmu4A1zwKO0f8z6NUoDIkDZU9eQze9AfB2b24NWaYwCV8DpIGbvJZabKfxbDm1D9BI/Kjfzj5Pl7NLN+RrB3kya8fuFkm8jniuRfW9FI7zgmtm7s5kJLxu+2mXcVaagcXx3Qp8a7z4kOsxB2DMqUxuBqz46NYk8CYTgSFDY3per8DS0vIzdOItYVyNv6jiqCUhJ0+ybYJQTSE8dz5Sw0Kziv9A4PTDl1zaHDJTGCNrO3U30nhsSLAbXeWsSxOXGoO1ZUlciz3XxqrPn6NFIJaQh2EYx5xXb9jkPIOBtlLJ/jzGZdwxgYEr7Fy3EQQtf64rQxp2H/ffjOHkUPNCxdGGW43XLCm1AW+l7rxRmXa24Eo+SzviWVrq8AtePmGm40Gxf2VdOAbXoScHr8a/+g=
secure: wodcNkhAd1+OSGZDIkxEP1U9VAyHAOceDBvZ4DkPg41I4oPBNtFbPIMbM93yohb4hiMNv9I0wM0xasox5ipsws4mEcdewHbi4T6+CYKiNG6FKvTd4oY7/wJrRGfqbKyvT0JrsFvrMxJCf4+AmeLTNgATQ9Ip5+IgahYdkSX2Ja9g15hCY2S/XoT/E+M5gB0amM4+quFKgmvHFidlsiA5jpKT26DoZa1UbypBLvVcvSVfITQsQ9ZOz0n93rpbghfISvcumHRBjkNLkKK8LL+46oLH9+I9+M2YCz5dJ4BLBd++Fr1sQBvsp6+CAHt5k3zGG7BXh0CRjOxxtr6sxqf7ZwctgwBQKfc4eFAkN3YeUD+y6d8BtV7fLujWzeAcBlZSwwZMdl09FS9p/saYRUC/9O/q+se8kYiOaNapfasafIVFYLHZXsUA0cc6Yxuwy1/pdyDNVo0qzdP+p+r7aZKujY18SsGPwhXmhD6bQ1ABYlOGmt2vNw4FTWbYlDNaSDwMeFnOVtYCuqsrIickkTZf1gVgMP9dKCbmmyoL7O+7Cw3TLnhMdmnNRJM97D24dIC1NDGkvNFF9mHbF/6jZ4nReVnWZLLoDkr//mf/W7oFsAZpsyJh3hDeUu9Xs2yjawmkjcbyF8oaSxlQq+EmRIZn2J+6AjrgBfMaAB5PfRF+0Q8=
on:
tags: true
repo: Trax-air/swagger-tester
Expand Down
20 changes: 10 additions & 10 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Types of Contributions
Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/cyprieng/swagger-tester/issues.
Report bugs at https://github.com/cyprieng/swagger_tester/issues.

If you are reporting a bug, please include:

Expand Down Expand Up @@ -45,7 +45,7 @@ articles, and such.
Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/cyprieng/swagger-tester/issues.
The best way to send feedback is to file an issue at https://github.com/cyprieng/swagger_tester/issues.

If you are proposing a feature:

Expand All @@ -57,17 +57,17 @@ If you are proposing a feature:
Get Started!
------------

Ready to contribute? Here's how to set up `swagger-tester` for local development.
Ready to contribute? Here's how to set up `swagger_tester` for local development.

1. Fork the `swagger-tester` repo on GitHub.
1. Fork the `swagger_tester` repo on GitHub.
2. Clone your fork locally::

$ git clone [email protected]:your_name_here/swagger-tester.git
$ git clone [email protected]:your_name_here/swagger_tester.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::

$ mkvirtualenv swagger-tester
$ cd swagger-tester/
$ mkvirtualenv swagger_tester
$ cd swagger_tester/
$ python setup.py develop

4. Create a branch for local development::
Expand All @@ -78,7 +78,7 @@ Ready to contribute? Here's how to set up `swagger-tester` for local development

5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::

$ flake8 swagger-tester tests
$ flake8 swagger_tester tests
$ python setup.py test
$ tox

Expand All @@ -102,12 +102,12 @@ Before you submit a pull request, check that it meets these guidelines:
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
https://travis-ci.org/cyprieng/swagger-tester/pull_requests
https://travis-ci.org/cyprieng/swagger_tester/pull_requests
and make sure that the tests pass for all supported Python versions.

Tips
----

To run a subset of tests::

$ python -m unittest tests.test_swagger-tester
$ python -m unittest tests.test_swagger_tester
8 changes: 4 additions & 4 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -85,17 +85,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/swagger-tester.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/swagger_tester.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/swagger-tester.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/swagger_tester.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/swagger-tester"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/swagger-tester"
@echo "# mkdir -p $$HOME/.local/share/devhelp/swagger_tester"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/swagger_tester"
@echo "# devhelp"

epub:
Expand Down
18 changes: 9 additions & 9 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# swagger-tester documentation build configuration file, created by
# swagger_tester documentation build configuration file, created by
# sphinx-quickstart on Tue Jul 9 22:26:36 2013.
#
# This file is execfile()d with the current directory set to its
Expand Down Expand Up @@ -31,7 +31,7 @@
# version is used.
sys.path.insert(0, project_root)

import swagger-tester
import swagger_tester

# -- General configuration ---------------------------------------------

Expand Down Expand Up @@ -63,9 +63,9 @@
# the built documents.
#
# The short X.Y version.
version = swagger-tester.__version__
version = swagger_tester.__version__
# The full version, including alpha/beta/rc tags.
release = swagger-tester.__version__
release = swagger_tester.__version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -188,7 +188,7 @@
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'swagger-testerdoc'
htmlhelp_basename = 'swagger_testerdoc'


# -- Options for LaTeX output ------------------------------------------
Expand All @@ -208,7 +208,7 @@
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index', 'swagger-tester.tex',
('index', 'swagger_tester.tex',
u'Swagger Tester Documentation',
u'Cyprien Guillemot', 'manual'),
]
Expand Down Expand Up @@ -239,7 +239,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'swagger-tester',
('index', 'swagger_tester',
u'Swagger Tester Documentation',
[u'Cyprien Guillemot'], 1)
]
Expand All @@ -254,10 +254,10 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'swagger-tester',
('index', 'swagger_tester',
u'Swagger Tester Documentation',
u'Cyprien Guillemot',
'swagger-tester',
'swagger_tester',
'One line description of project.',
'Miscellaneous'),
]
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. swagger-tester documentation master file, created by
.. swagger_tester documentation master file, created by
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Expand Down
6 changes: 3 additions & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Installation

At the command line::

$ easy_install swagger-tester
$ easy_install swagger_tester

Or, if you have virtualenvwrapper installed::

$ mkvirtualenv swagger-tester
$ pip install swagger-tester
$ mkvirtualenv swagger_tester
$ pip install swagger_tester
4 changes: 2 additions & 2 deletions docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,9 @@ if "%1" == "qthelp" (
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\swagger-tester.qhcp
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\swagger_tester.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\swagger-tester.ghc
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\swagger_tester.ghc
goto end
)

Expand Down
2 changes: 1 addition & 1 deletion travis_pypi_setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
from urllib.request import urlopen


GITHUB_REPO = 'cyprieng/swagger-tester'
GITHUB_REPO = 'Trax-air/swagger-tester'
TRAVIS_CONFIG_FILE = os.path.join(
os.path.dirname(os.path.abspath(__file__)), '.travis.yml')

Expand Down

0 comments on commit c8cd182

Please sign in to comment.