Skip to content

Commit c8cd182

Browse files
cypriengcyprien-g
authored andcommitted
Fix docs
1 parent 5d05e2f commit c8cd182

File tree

8 files changed

+31
-31
lines changed

8 files changed

+31
-31
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ deploy:
1010
distributions: sdist bdist_wheel
1111
user: cyprieng
1212
password:
13-
secure: XITH5fCPmchCp8C2DHaQJYZfsgDSLnicVpZ7EYW/hh+UHvwTwtk/ueAypi38wt0lzciL61t2Z2YPTjQJchOtUGPGQ3FwMiqMHS4+W0H2aj45jPWttJ3yqvP7k9eEqjUeDJHUX8J3HK6JkofFnVJjxCiUUmsP30U7tF1oWqcHoI/fUlH0H6rJJLT0So/1q1BqWnxtvxhPcUsiV6R1A6Eo/tBu84NtIBZfTtcFVyUEWhgCGhJFnN0Gcm1irWiO5bWSA0AJz/YhRujVzssp7ccVZExxmu4A1zwKO0f8z6NUoDIkDZU9eQze9AfB2b24NWaYwCV8DpIGbvJZabKfxbDm1D9BI/Kjfzj5Pl7NLN+RrB3kya8fuFkm8jniuRfW9FI7zgmtm7s5kJLxu+2mXcVaagcXx3Qp8a7z4kOsxB2DMqUxuBqz46NYk8CYTgSFDY3per8DS0vIzdOItYVyNv6jiqCUhJ0+ybYJQTSE8dz5Sw0Kziv9A4PTDl1zaHDJTGCNrO3U30nhsSLAbXeWsSxOXGoO1ZUlciz3XxqrPn6NFIJaQh2EYx5xXb9jkPIOBtlLJ/jzGZdwxgYEr7Fy3EQQtf64rQxp2H/ffjOHkUPNCxdGGW43XLCm1AW+l7rxRmXa24Eo+SzviWVrq8AtePmGm40Gxf2VdOAbXoScHr8a/+g=
13+
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=
1414
on:
1515
tags: true
1616
repo: Trax-air/swagger-tester

CONTRIBUTING.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Types of Contributions
1515
Report Bugs
1616
~~~~~~~~~~~
1717

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

2020
If you are reporting a bug, please include:
2121

@@ -45,7 +45,7 @@ articles, and such.
4545
Submit Feedback
4646
~~~~~~~~~~~~~~~
4747

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

5050
If you are proposing a feature:
5151

@@ -57,17 +57,17 @@ If you are proposing a feature:
5757
Get Started!
5858
------------
5959

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

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

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

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

69-
$ mkvirtualenv swagger-tester
70-
$ cd swagger-tester/
69+
$ mkvirtualenv swagger_tester
70+
$ cd swagger_tester/
7171
$ python setup.py develop
7272

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

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

81-
$ flake8 swagger-tester tests
81+
$ flake8 swagger_tester tests
8282
$ python setup.py test
8383
$ tox
8484

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

108108
Tips
109109
----
110110

111111
To run a subset of tests::
112112

113-
$ python -m unittest tests.test_swagger-tester
113+
$ python -m unittest tests.test_swagger_tester

docs/Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,17 +85,17 @@ qthelp:
8585
@echo
8686
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
8787
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/swagger-tester.qhcp"
88+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/swagger_tester.qhcp"
8989
@echo "To view the help file:"
90-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/swagger-tester.qhc"
90+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/swagger_tester.qhc"
9191

9292
devhelp:
9393
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
9494
@echo
9595
@echo "Build finished."
9696
@echo "To view the help file:"
97-
@echo "# mkdir -p $$HOME/.local/share/devhelp/swagger-tester"
98-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/swagger-tester"
97+
@echo "# mkdir -p $$HOME/.local/share/devhelp/swagger_tester"
98+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/swagger_tester"
9999
@echo "# devhelp"
100100

101101
epub:

docs/conf.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env python
22
# -*- coding: utf-8 -*-
33
#
4-
# swagger-tester documentation build configuration file, created by
4+
# swagger_tester documentation build configuration file, created by
55
# sphinx-quickstart on Tue Jul 9 22:26:36 2013.
66
#
77
# This file is execfile()d with the current directory set to its
@@ -31,7 +31,7 @@
3131
# version is used.
3232
sys.path.insert(0, project_root)
3333

34-
import swagger-tester
34+
import swagger_tester
3535

3636
# -- General configuration ---------------------------------------------
3737

@@ -63,9 +63,9 @@
6363
# the built documents.
6464
#
6565
# The short X.Y version.
66-
version = swagger-tester.__version__
66+
version = swagger_tester.__version__
6767
# The full version, including alpha/beta/rc tags.
68-
release = swagger-tester.__version__
68+
release = swagger_tester.__version__
6969

7070
# The language for content autogenerated by Sphinx. Refer to documentation
7171
# for a list of supported languages.
@@ -188,7 +188,7 @@
188188
#html_file_suffix = None
189189

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

193193

194194
# -- Options for LaTeX output ------------------------------------------
@@ -208,7 +208,7 @@
208208
# (source start file, target name, title, author, documentclass
209209
# [howto/manual]).
210210
latex_documents = [
211-
('index', 'swagger-tester.tex',
211+
('index', 'swagger_tester.tex',
212212
u'Swagger Tester Documentation',
213213
u'Cyprien Guillemot', 'manual'),
214214
]
@@ -239,7 +239,7 @@
239239
# One entry per manual page. List of tuples
240240
# (source start file, name, description, authors, manual section).
241241
man_pages = [
242-
('index', 'swagger-tester',
242+
('index', 'swagger_tester',
243243
u'Swagger Tester Documentation',
244244
[u'Cyprien Guillemot'], 1)
245245
]
@@ -254,10 +254,10 @@
254254
# (source start file, target name, title, author,
255255
# dir menu entry, description, category)
256256
texinfo_documents = [
257-
('index', 'swagger-tester',
257+
('index', 'swagger_tester',
258258
u'Swagger Tester Documentation',
259259
u'Cyprien Guillemot',
260-
'swagger-tester',
260+
'swagger_tester',
261261
'One line description of project.',
262262
'Miscellaneous'),
263263
]

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. swagger-tester documentation master file, created by
1+
.. swagger_tester documentation master file, created by
22
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.

docs/installation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Installation
66

77
At the command line::
88

9-
$ easy_install swagger-tester
9+
$ easy_install swagger_tester
1010

1111
Or, if you have virtualenvwrapper installed::
1212

13-
$ mkvirtualenv swagger-tester
14-
$ pip install swagger-tester
13+
$ mkvirtualenv swagger_tester
14+
$ pip install swagger_tester

docs/make.bat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,9 @@ if "%1" == "qthelp" (
115115
echo.
116116
echo.Build finished; now you can run "qcollectiongenerator" with the ^
117117
.qhcp project file in %BUILDDIR%/qthelp, like this:
118-
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\swagger-tester.qhcp
118+
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\swagger_tester.qhcp
119119
echo.To view the help file:
120-
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\swagger-tester.ghc
120+
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\swagger_tester.ghc
121121
goto end
122122
)
123123

travis_pypi_setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
from urllib.request import urlopen
2222

2323

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

0 commit comments

Comments
 (0)