Skip to content

Commit bfcca35

Browse files
TheTripleVTheTripleV
committed
initial commit
0 parents  commit bfcca35

File tree

6 files changed

+484
-0
lines changed

6 files changed

+484
-0
lines changed

‎.gitignore‎

Lines changed: 222 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
2+
# Created by https://www.toptal.com/developers/gitignore/api/python,linux,windows,macos,visualstudiocode
3+
# Edit at https://www.toptal.com/developers/gitignore?templates=python,linux,windows,macos,visualstudiocode
4+
5+
### Linux ###
6+
*~
7+
8+
# temporary files which can be created if a process still has a handle open of a deleted file
9+
.fuse_hidden*
10+
11+
# KDE directory preferences
12+
.directory
13+
14+
# Linux trash folder which might appear on any partition or disk
15+
.Trash-*
16+
17+
# .nfs files are created when an open file is removed but is still being accessed
18+
.nfs*
19+
20+
### macOS ###
21+
# General
22+
.DS_Store
23+
.AppleDouble
24+
.LSOverride
25+
26+
# Icon must end with two \r
27+
Icon
28+
29+
# Thumbnails
30+
._*
31+
32+
# Files that might appear in the root of a volume
33+
.DocumentRevisions-V100
34+
.fseventsd
35+
.Spotlight-V100
36+
.TemporaryItems
37+
.Trashes
38+
.VolumeIcon.icns
39+
.com.apple.timemachine.donotpresent
40+
41+
# Directories potentially created on remote AFP share
42+
.AppleDB
43+
.AppleDesktop
44+
Network Trash Folder
45+
Temporary Items
46+
.apdisk
47+
48+
### Python ###
49+
# Byte-compiled / optimized / DLL files
50+
__pycache__/
51+
*.py[cod]
52+
*$py.class
53+
54+
# C extensions
55+
*.so
56+
57+
# Distribution / packaging
58+
.Python
59+
build/
60+
develop-eggs/
61+
dist/
62+
downloads/
63+
eggs/
64+
.eggs/
65+
lib/
66+
lib64/
67+
parts/
68+
sdist/
69+
var/
70+
wheels/
71+
pip-wheel-metadata/
72+
share/python-wheels/
73+
*.egg-info/
74+
.installed.cfg
75+
*.egg
76+
MANIFEST
77+
78+
# PyInstaller
79+
# Usually these files are written by a python script from a template
80+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
81+
*.manifest
82+
*.spec
83+
84+
# Installer logs
85+
pip-log.txt
86+
pip-delete-this-directory.txt
87+
88+
# Unit test / coverage reports
89+
htmlcov/
90+
.tox/
91+
.nox/
92+
.coverage
93+
.coverage.*
94+
.cache
95+
nosetests.xml
96+
coverage.xml
97+
*.cover
98+
*.py,cover
99+
.hypothesis/
100+
.pytest_cache/
101+
pytestdebug.log
102+
103+
# Translations
104+
*.mo
105+
*.pot
106+
107+
# Django stuff:
108+
*.log
109+
local_settings.py
110+
db.sqlite3
111+
db.sqlite3-journal
112+
113+
# Flask stuff:
114+
instance/
115+
.webassets-cache
116+
117+
# Scrapy stuff:
118+
.scrapy
119+
120+
# Sphinx documentation
121+
docs/_build/
122+
doc/_build/
123+
124+
# PyBuilder
125+
target/
126+
127+
# Jupyter Notebook
128+
.ipynb_checkpoints
129+
130+
# IPython
131+
profile_default/
132+
ipython_config.py
133+
134+
# pyenv
135+
.python-version
136+
137+
# pipenv
138+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
139+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
140+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
141+
# install all needed dependencies.
142+
#Pipfile.lock
143+
144+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
145+
__pypackages__/
146+
147+
# Celery stuff
148+
celerybeat-schedule
149+
celerybeat.pid
150+
151+
# SageMath parsed files
152+
*.sage.py
153+
154+
# Environments
155+
.env
156+
.venv
157+
env/
158+
venv/
159+
ENV/
160+
env.bak/
161+
venv.bak/
162+
163+
# Spyder project settings
164+
.spyderproject
165+
.spyproject
166+
167+
# Rope project settings
168+
.ropeproject
169+
170+
# mkdocs documentation
171+
/site
172+
173+
# mypy
174+
.mypy_cache/
175+
.dmypy.json
176+
dmypy.json
177+
178+
# Pyre type checker
179+
.pyre/
180+
181+
# pytype static type analyzer
182+
.pytype/
183+
184+
### VisualStudioCode ###
185+
.vscode/*
186+
!.vscode/settings.json
187+
!.vscode/tasks.json
188+
!.vscode/launch.json
189+
!.vscode/extensions.json
190+
*.code-workspace
191+
192+
### VisualStudioCode Patch ###
193+
# Ignore all local history of files
194+
.history
195+
196+
### Windows ###
197+
# Windows thumbnail cache files
198+
Thumbs.db
199+
Thumbs.db:encryptable
200+
ehthumbs.db
201+
ehthumbs_vista.db
202+
203+
# Dump file
204+
*.stackdump
205+
206+
# Folder config file
207+
[Dd]esktop.ini
208+
209+
# Recycle Bin used on file shares
210+
$RECYCLE.BIN/
211+
212+
# Windows Installer files
213+
*.cab
214+
*.msi
215+
*.msix
216+
*.msm
217+
*.msp
218+
219+
# Windows shortcuts
220+
*.lnk
221+
222+
# End of https://www.toptal.com/developers/gitignore/api/python,linux,windows,macos,visualstudiocode

‎LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Vasista Vovveti
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# sphinxext-rediraffe
2+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
3+
4+
Sphinx Extension to redirect files
5+
6+
## Installation
7+
8+
`python -m pip install https://github.com/TheTripleV/sphinxext-rediraffe`
9+
10+
## Usage
11+
Add `sphinxext.rediraffe` to your extensions list in your `conf.py`
12+
13+
```python
14+
extensions = [
15+
sphinxext.rediraffe,
16+
]
17+
```
18+
<!-- ## Options
19+
These values are placed in the conf.py of your sphinx project.
20+
21+
* `linkcheckdiff_branch`
22+
* Required. The branch to diff against.
23+
24+
Note: linkcheckdiff is an extension of the linkcheck builder that ships with Sphinx. linkcheckdiff respects all of linkcheck's configuration options.
25+
26+
27+
## Example Config
28+
29+
```python
30+
linkcheckdiff_branch = "master"
31+
``` -->

‎dev-requirements.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx
2+
wheel==0.34.2
3+
setuptools==47.3.1

‎setup.py‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
import subprocess
2+
import setuptools
3+
4+
try:
5+
ret = subprocess.check_output("git describe --tags --abbrev=0", shell=True,)
6+
version = ret.decode("utf-8").strip()
7+
except:
8+
version = "master"
9+
10+
with open("README.md", "r", encoding="utf-8") as readme:
11+
long_description = readme.read()
12+
13+
setuptools.setup(
14+
name="sphinxext-linkcheckdiff",
15+
version=version,
16+
author="Vasista Vovveti",
17+
author_email="[email protected]",
18+
description="Sphinx Extension to run diff-only linkchecks",
19+
long_description=long_description,
20+
long_description_content_type="text/markdown",
21+
url="https://github.com/thetriplev/sphinxext-linkcheckdiff",
22+
install_requires=["sphinx>=2.0"],
23+
packages=["sphinxext"],
24+
classifiers=[
25+
"Environment :: Plugins",
26+
"Environment :: Web Environment",
27+
"Framework :: Sphinx :: Extension",
28+
"Intended Audience :: Developers",
29+
"License :: OSI Approved :: MIT License",
30+
"Natural Language :: English",
31+
"Operating System :: OS Independent",
32+
"Programming Language :: Python :: 3.6",
33+
"Programming Language :: Python :: 3.7",
34+
"Programming Language :: Python :: 3.8",
35+
"Programming Language :: Python",
36+
"Topic :: Documentation :: Sphinx",
37+
"Topic :: Documentation",
38+
"Topic :: Software Development :: Documentation",
39+
"Topic :: Text Processing",
40+
"Topic :: Utilities",
41+
],
42+
python_requires=">=3.6",
43+
)

0 commit comments

Comments
 (0)