Skip to content

Commit cc0a542

Browse files
committed
Changes re: transfer to org, and docs improvements.
1 parent 3621777 commit cc0a542

File tree

11 files changed

+146
-244
lines changed

11 files changed

+146
-244
lines changed

README.rst

Lines changed: 28 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -26,48 +26,48 @@ flake8_sphinx_links
2626
* - Activity
2727
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
2828
* - QA
29-
- |codefactor| |actions_flake8| |actions_mypy| |pre_commit_ci|
29+
- |codefactor| |actions_flake8| |actions_mypy|
3030
* - Other
3131
- |license| |language| |requires|
3232

3333
.. |docs| image:: https://img.shields.io/readthedocs/flake8-sphinx-links/latest?logo=read-the-docs
3434
:target: https://flake8-sphinx-links.readthedocs.io/en/latest
3535
:alt: Documentation Build Status
3636

37-
.. |docs_check| image:: https://github.com/domdfcoding/flake8-sphinx-links/workflows/Docs%20Check/badge.svg
38-
:target: https://github.com/domdfcoding/flake8-sphinx-links/actions?query=workflow%3A%22Docs+Check%22
37+
.. |docs_check| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/Docs%20Check/badge.svg
38+
:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22Docs+Check%22
3939
:alt: Docs Check Status
4040

41-
.. |actions_linux| image:: https://github.com/domdfcoding/flake8-sphinx-links/workflows/Linux/badge.svg
42-
:target: https://github.com/domdfcoding/flake8-sphinx-links/actions?query=workflow%3A%22Linux%22
41+
.. |actions_linux| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/Linux/badge.svg
42+
:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22Linux%22
4343
:alt: Linux Test Status
4444

45-
.. |actions_windows| image:: https://github.com/domdfcoding/flake8-sphinx-links/workflows/Windows/badge.svg
46-
:target: https://github.com/domdfcoding/flake8-sphinx-links/actions?query=workflow%3A%22Windows%22
45+
.. |actions_windows| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/Windows/badge.svg
46+
:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22Windows%22
4747
:alt: Windows Test Status
4848

49-
.. |actions_macos| image:: https://github.com/domdfcoding/flake8-sphinx-links/workflows/macOS/badge.svg
50-
:target: https://github.com/domdfcoding/flake8-sphinx-links/actions?query=workflow%3A%22macOS%22
49+
.. |actions_macos| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/macOS/badge.svg
50+
:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22macOS%22
5151
:alt: macOS Test Status
5252

53-
.. |actions_flake8| image:: https://github.com/domdfcoding/flake8-sphinx-links/workflows/Flake8/badge.svg
54-
:target: https://github.com/domdfcoding/flake8-sphinx-links/actions?query=workflow%3A%22Flake8%22
53+
.. |actions_flake8| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/Flake8/badge.svg
54+
:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22Flake8%22
5555
:alt: Flake8 Status
5656

57-
.. |actions_mypy| image:: https://github.com/domdfcoding/flake8-sphinx-links/workflows/mypy/badge.svg
58-
:target: https://github.com/domdfcoding/flake8-sphinx-links/actions?query=workflow%3A%22mypy%22
57+
.. |actions_mypy| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/mypy/badge.svg
58+
:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22mypy%22
5959
:alt: mypy status
6060

61-
.. |requires| image:: https://requires.io/github/domdfcoding/flake8-sphinx-links/requirements.svg?branch=master
62-
:target: https://requires.io/github/domdfcoding/flake8-sphinx-links/requirements/?branch=master
61+
.. |requires| image:: https://requires.io/github/python-formate/flake8-sphinx-links/requirements.svg?branch=master
62+
:target: https://requires.io/github/python-formate/flake8-sphinx-links/requirements/?branch=master
6363
:alt: Requirements Status
6464

65-
.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/flake8-sphinx-links/master?logo=coveralls
66-
:target: https://coveralls.io/github/domdfcoding/flake8-sphinx-links?branch=master
65+
.. |coveralls| image:: https://img.shields.io/coveralls/github/python-formate/flake8-sphinx-links/master?logo=coveralls
66+
:target: https://coveralls.io/github/python-formate/flake8-sphinx-links?branch=master
6767
:alt: Coverage
6868

69-
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/flake8-sphinx-links?logo=codefactor
70-
:target: https://www.codefactor.io/repository/github/domdfcoding/flake8-sphinx-links
69+
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/python-formate/flake8-sphinx-links?logo=codefactor
70+
:target: https://www.codefactor.io/repository/github/python-formate/flake8-sphinx-links
7171
:alt: CodeFactor Grade
7272

7373
.. |pypi-version| image:: https://img.shields.io/pypi/v/flake8_sphinx_links
@@ -94,19 +94,19 @@ flake8_sphinx_links
9494
:target: https://anaconda.org/domdfcoding/flake8_sphinx_links
9595
:alt: Conda - Platform
9696

97-
.. |license| image:: https://img.shields.io/github/license/domdfcoding/flake8-sphinx-links
98-
:target: https://github.com/domdfcoding/flake8-sphinx-links/blob/master/LICENSE
97+
.. |license| image:: https://img.shields.io/github/license/python-formate/flake8-sphinx-links
98+
:target: https://github.com/python-formate/flake8-sphinx-links/blob/master/LICENSE
9999
:alt: License
100100

101-
.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/flake8-sphinx-links
101+
.. |language| image:: https://img.shields.io/github/languages/top/python-formate/flake8-sphinx-links
102102
:alt: GitHub top language
103103

104-
.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/flake8-sphinx-links/v0.2.1
105-
:target: https://github.com/domdfcoding/flake8-sphinx-links/pulse
104+
.. |commits-since| image:: https://img.shields.io/github/commits-since/python-formate/flake8-sphinx-links/v0.2.1
105+
:target: https://github.com/python-formate/flake8-sphinx-links/pulse
106106
:alt: GitHub commits since tagged version
107107

108-
.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/flake8-sphinx-links
109-
:target: https://github.com/domdfcoding/flake8-sphinx-links/commit/master
108+
.. |commits-latest| image:: https://img.shields.io/github/last-commit/python-formate/flake8-sphinx-links
109+
:target: https://github.com/python-formate/flake8-sphinx-links/commit/master
110110
:alt: GitHub last commit
111111

112112
.. |maintained| image:: https://img.shields.io/maintenance/yes/2021
@@ -116,10 +116,6 @@ flake8_sphinx_links
116116
:target: https://pypi.org/project/flake8_sphinx_links/
117117
:alt: PyPI - Downloads
118118

119-
.. |pre_commit_ci| image:: https://results.pre-commit.ci/badge/github/domdfcoding/flake8-sphinx-links/master.svg
120-
:target: https://results.pre-commit.ci/latest/github/domdfcoding/flake8-sphinx-links/master
121-
:alt: pre-commit.ci status
122-
123119
.. end shields
124120
125121
For example, \`\`True\`\` should be py\:obj:\`True\`, which Sphinx will render as a link to the Python documentation.
@@ -145,8 +141,8 @@ To install with ``conda``:
145141

146142
.. code-block:: bash
147143
148-
$ conda config --add channels http://conda.anaconda.org/conda-forge
149-
$ conda config --add channels http://conda.anaconda.org/domdfcoding
144+
$ conda config --add channels https://conda.anaconda.org/conda-forge
145+
$ conda config --add channels https://conda.anaconda.org/domdfcoding
150146
151147
* Then install
152148

doc-source/Source.rst

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,31 @@ Downloading source code
33
=========================
44

55
The ``flake8_sphinx_links`` source code is available on GitHub,
6-
and can be accessed from the following URL: https://github.com/domdfcoding/flake8-sphinx-links
6+
and can be accessed from the following URL: https://github.com/python-formate/flake8-sphinx-links
77

88
If you have ``git`` installed, you can clone the repository with the following command:
99

10-
.. code-block:: bash
10+
.. prompt:: bash
11+
12+
git clone https://github.com/python-formate/flake8-sphinx-links
13+
14+
.. parsed-literal::
1115
12-
$ git clone https://github.com/domdfcoding/flake8-sphinx-links"
13-
> Cloning into 'flake8-sphinx-links'...
14-
> remote: Enumerating objects: 47, done.
15-
> remote: Counting objects: 100% (47/47), done.
16-
> remote: Compressing objects: 100% (41/41), done.
17-
> remote: Total 173 (delta 16), reused 17 (delta 6), pack-reused 126
18-
> Receiving objects: 100% (173/173), 126.56 KiB | 678.00 KiB/s, done.
19-
> Resolving deltas: 100% (66/66), done.
16+
Cloning into 'flake8-sphinx-links'...
17+
remote: Enumerating objects: 47, done.
18+
remote: Counting objects: 100% (47/47), done.
19+
remote: Compressing objects: 100% (41/41), done.
20+
remote: Total 173 (delta 16), reused 17 (delta 6), pack-reused 126
21+
Receiving objects: 100% (173/173), 126.56 KiB | 678.00 KiB/s, done.
22+
Resolving deltas: 100% (66/66), done.
2023
2124
| Alternatively, the code can be downloaded in a 'zip' file by clicking:
2225
| :guilabel:`Clone or download` --> :guilabel:`Download Zip`
2326
2427
.. figure:: git_download.png
25-
:alt: Downloading a 'zip' file of the source code.
28+
:alt: Downloading a 'zip' file of the source code.
2629

27-
Downloading a 'zip' file of the source code
30+
Downloading a 'zip' file of the source code
2831

2932

3033
Building from source

doc-source/_templates/sidebar/navigation.html

Lines changed: 0 additions & 12 deletions
This file was deleted.

doc-source/contributing.rst

Lines changed: 0 additions & 72 deletions
This file was deleted.

doc-source/docs.rst

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
1-
===========================
1+
=================
22
API Reference
3-
===========================
3+
=================
4+
5+
In addition to the Flake8 plugin, the following public API is available
6+
to allow other plugins to build on top of ``flake8-sphinx-links``.
7+
8+
.. autosummary-widths:: 25/100
49

510
.. automodule:: flake8_sphinx_links
6-
:undoc-members:
11+
:no-docstring:
12+
:no-members:
13+
:autosummary-members:
14+
15+
.. autoclass:: flake8_sphinx_links.Plugin
16+
:no-members:
17+
18+
.. autoclass:: flake8_sphinx_links.Visitor
19+
.. autovariable:: flake8_sphinx_links.exc
20+
.. autovariable:: flake8_sphinx_links.py_obj
21+
.. autovariable:: flake8_sphinx_links.py_obj_pattern
22+
23+
.. autoregex:: flake8_sphinx_links.regex
24+
:no-value:

0 commit comments

Comments
 (0)