Hopiu/linkchecker
1
0
Fork 0
mirror of https://github.com/Hopiu/linkchecker.git synced 2026-05-27 23:33:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #585 from cjmayo/scm_git_archive

Browse source 
Make installing from the git archive of a tagged commit possible
This commit is contained in:
Chris Mayo 2021-12-13 19:23:34 +00:00 committed by GitHub
commit 96f207d25f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.git_archival.txt Normal file
View file

@ -0,0 +1 @@
ref-names: $Format:%D$

1
.gitattributes vendored
View file

@ -1,3 +1,4 @@
.git_archival.txt export-subst
.gitattributes export-ignore .gitattributes export-ignore
.gitignore export-ignore .gitignore export-ignore
/doc/web export-ignore /doc/web export-ignore

10
doc/development.md
View file

@ -66,12 +66,12 @@ Release process
4. submit a pull request 4. submit a pull request
5. create a new git clone 5. create release (vX.Y.Z) on GitHub
6. check Python polib package is installed 6. create a new git clone
7. build Python distribution files (`setup.py sdist bdist_wheel`) 7. check Python polib package is installed
8. check distribution files (`twine check dist/*`) and upload to PyPI (`twine upload dist/*`) 8. build Python distribution files (`setup.py sdist bdist_wheel`)
9. create release (vX.Y.Z) on GitHub (warn users about GitHub archives) 9. check distribution files (`twine check dist/*`) and upload to PyPI (`twine upload dist/*`)

8
doc/install.txt
View file

@ -7,6 +7,10 @@ When installing from source, for application translations to be installed
polib_ needs to be installed before LinkChecker. After LinkChecker installation polib_ needs to be installed before LinkChecker. After LinkChecker installation
polib_ can be removed. polib_ can be removed.
Installing from the GitHub release assets requires setuptools-scm-git-archive_.
pip-run_ may be useful for both of these cases.
There are several steps to resolve problems with detecting the character There are several steps to resolve problems with detecting the character
encoding of checked HTML pages: encoding of checked HTML pages:
first ensure the web server, if used, is not returning an incorrect charset in first ensure the web server, if used, is not returning an incorrect charset in
@ -20,10 +24,14 @@ used.
.. _chardet: https://pypi.org/project/chardet/ .. _chardet: https://pypi.org/project/chardet/
.. _pip-run: https://pypi.org/project/pip-run/
.. _cchardet: https://pypi.org/project/cchardet/ .. _cchardet: https://pypi.org/project/cchardet/
.. _polib: https://pypi.org/project/polib/ .. _polib: https://pypi.org/project/polib/
.. _setuptools-scm-git-archive: https://pypi.org/project/setuptools-scm-git-archive/
.. _venv: https://docs.python.org/3/library/venv.html#creating-virtual-environments .. _venv: https://docs.python.org/3/library/venv.html#creating-virtual-environments
Setup with pip Setup with pip