Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit d0be6fa

Browse files
committed
Replace instances of astropy_helpers.sphinx.ext with sphinx_automodapi
1 parent 46dc9af commit d0be6fa

File tree

5 files changed

+33
-33
lines changed

5 files changed

+33
-33
lines changed

sphinx_automodapi/automodapi.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@ def process_automodapi(app, docname, source):
379379

380380
def setup(app):
381381
# need automodsumm for automodapi
382-
app.setup_extension('astropy_helpers.sphinx.ext.automodsumm')
382+
app.setup_extension('sphinx_automodapi.automodsumm')
383383

384384
app.connect('source-read', process_automodapi)
385385

sphinx_automodapi/automodsumm.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -308,8 +308,8 @@ def automodsumm_to_autosummary_lines(fn, app):
308308
fullfn = os.path.join(app.builder.env.srcdir, fn)
309309

310310
with open(fullfn) as fr:
311-
if 'astropy_helpers.sphinx.ext.automodapi' in app._extensions:
312-
from astropy_helpers.sphinx.ext.automodapi import automodapi_replace
311+
if 'sphinx_automodapi.automodapi' in app._extensions:
312+
from sphinx_automodapi.automodapi import automodapi_replace
313313
# Must do the automodapi on the source to get the automodsumm
314314
# that might be in there
315315
docname = os.path.splitext(fn)[0]
@@ -621,8 +621,8 @@ def get_members_class(obj, typ, include_public=[],
621621

622622
def setup(app):
623623
# need our autosummary and autodoc fixes
624-
app.setup_extension('astropy_helpers.sphinx.ext.astropyautosummary')
625-
app.setup_extension('astropy_helpers.sphinx.ext.autodoc_enhancements')
624+
app.setup_extension('sphinx_automodapi.astropyautosummary')
625+
app.setup_extension('sphinx_automodapi.autodoc_enhancements')
626626
# need inheritance-diagram for automod-diagram
627627
app.setup_extension('sphinx.ext.inheritance_diagram')
628628

sphinx_automodapi/tests/test_automodapi.py

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ def warn(self, msg, loc):
4848
am_replacer_str = """
4949
This comes before
5050
51-
.. automodapi:: astropy_helpers.sphinx.ext.tests.test_automodapi
51+
.. automodapi:: sphinx_automodapi.tests.test_automodapi
5252
{options}
5353
5454
This comes after
@@ -57,29 +57,29 @@ def warn(self, msg, loc):
5757
am_replacer_basic_expected = """
5858
This comes before
5959
60-
astropy_helpers.sphinx.ext.tests.test_automodapi Module
60+
sphinx_automodapi.tests.test_automodapi Module
6161
-------------------------------------------------------
6262
63-
.. automodule:: astropy_helpers.sphinx.ext.tests.test_automodapi
63+
.. automodule:: sphinx_automodapi.tests.test_automodapi
6464
6565
Functions
6666
^^^^^^^^^
6767
68-
.. automodsumm:: astropy_helpers.sphinx.ext.tests.test_automodapi
68+
.. automodsumm:: sphinx_automodapi.tests.test_automodapi
6969
:functions-only:
7070
:toctree: api/
7171
7272
Classes
7373
^^^^^^^
7474
75-
.. automodsumm:: astropy_helpers.sphinx.ext.tests.test_automodapi
75+
.. automodsumm:: sphinx_automodapi.tests.test_automodapi
7676
:classes-only:
7777
:toctree: api/
7878
7979
Class Inheritance Diagram
8080
^^^^^^^^^^^^^^^^^^^^^^^^^
8181
82-
.. automod-diagram:: astropy_helpers.sphinx.ext.tests.test_automodapi
82+
.. automod-diagram:: sphinx_automodapi.tests.test_automodapi
8383
:private-bases:
8484
:parts: 1
8585
{empty}
@@ -104,22 +104,22 @@ def test_am_replacer_basic():
104104
am_replacer_noinh_expected = """
105105
This comes before
106106
107-
astropy_helpers.sphinx.ext.tests.test_automodapi Module
107+
sphinx_automodapi.tests.test_automodapi Module
108108
-------------------------------------------------------
109109
110-
.. automodule:: astropy_helpers.sphinx.ext.tests.test_automodapi
110+
.. automodule:: sphinx_automodapi.tests.test_automodapi
111111
112112
Functions
113113
^^^^^^^^^
114114
115-
.. automodsumm:: astropy_helpers.sphinx.ext.tests.test_automodapi
115+
.. automodsumm:: sphinx_automodapi.tests.test_automodapi
116116
:functions-only:
117117
:toctree: api/
118118
119119
Classes
120120
^^^^^^^
121121
122-
.. automodsumm:: astropy_helpers.sphinx.ext.tests.test_automodapi
122+
.. automodsumm:: sphinx_automodapi.tests.test_automodapi
123123
:classes-only:
124124
:toctree: api/
125125
@@ -145,29 +145,29 @@ def test_am_replacer_noinh():
145145
am_replacer_titleandhdrs_expected = """
146146
This comes before
147147
148-
astropy_helpers.sphinx.ext.tests.test_automodapi Module
148+
sphinx_automodapi.tests.test_automodapi Module
149149
&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
150150
151-
.. automodule:: astropy_helpers.sphinx.ext.tests.test_automodapi
151+
.. automodule:: sphinx_automodapi.tests.test_automodapi
152152
153153
Functions
154154
*********
155155
156-
.. automodsumm:: astropy_helpers.sphinx.ext.tests.test_automodapi
156+
.. automodsumm:: sphinx_automodapi.tests.test_automodapi
157157
:functions-only:
158158
:toctree: api/
159159
160160
Classes
161161
*******
162162
163-
.. automodsumm:: astropy_helpers.sphinx.ext.tests.test_automodapi
163+
.. automodsumm:: sphinx_automodapi.tests.test_automodapi
164164
:classes-only:
165165
:toctree: api/
166166
167167
Class Inheritance Diagram
168168
*************************
169169
170-
.. automod-diagram:: astropy_helpers.sphinx.ext.tests.test_automodapi
170+
.. automod-diagram:: sphinx_automodapi.tests.test_automodapi
171171
:private-bases:
172172
:parts: 1
173173
{empty}
@@ -195,7 +195,7 @@ def test_am_replacer_titleandhdrs():
195195
am_replacer_nomain_str = """
196196
This comes before
197197
198-
.. automodapi:: astropy_helpers.sphinx.ext.automodapi
198+
.. automodapi:: sphinx_automodapi.automodapi
199199
:no-main-docstr:
200200
201201
This comes after
@@ -204,15 +204,15 @@ def test_am_replacer_titleandhdrs():
204204
am_replacer_nomain_expected = """
205205
This comes before
206206
207-
astropy_helpers.sphinx.ext.automodapi Module
207+
sphinx_automodapi.automodapi Module
208208
--------------------------------------------
209209
210210
211211
212212
Functions
213213
^^^^^^^^^
214214
215-
.. automodsumm:: astropy_helpers.sphinx.ext.automodapi
215+
.. automodsumm:: sphinx_automodapi.automodapi
216216
:functions-only:
217217
:toctree: api/
218218
@@ -236,7 +236,7 @@ def test_am_replacer_nomain():
236236
am_replacer_skip_str = """
237237
This comes before
238238
239-
.. automodapi:: astropy_helpers.sphinx.ext.automodapi
239+
.. automodapi:: sphinx_automodapi.automodapi
240240
:skip: something1
241241
:skip: something2
242242
@@ -246,15 +246,15 @@ def test_am_replacer_nomain():
246246
am_replacer_skip_expected = """
247247
This comes before
248248
249-
astropy_helpers.sphinx.ext.automodapi Module
249+
sphinx_automodapi.automodapi Module
250250
--------------------------------------------
251251
252-
.. automodule:: astropy_helpers.sphinx.ext.automodapi
252+
.. automodule:: sphinx_automodapi.automodapi
253253
254254
Functions
255255
^^^^^^^^^
256256
257-
.. automodsumm:: astropy_helpers.sphinx.ext.automodapi
257+
.. automodsumm:: sphinx_automodapi.automodapi
258258
:functions-only:
259259
:toctree: api/
260260
:skip: something1,something2
@@ -279,7 +279,7 @@ def test_am_replacer_skip():
279279
am_replacer_invalidop_str = """
280280
This comes before
281281
282-
.. automodapi:: astropy_helpers.sphinx.ext.automodapi
282+
.. automodapi:: sphinx_automodapi.automodapi
283283
:invalid-option:
284284
285285
This comes after

sphinx_automodapi/tests/test_automodsumm.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def __init__(self, srcdir, automodapipresent=True):
3737
self.warnings = []
3838
self._extensions = []
3939
if automodapipresent:
40-
self._extensions.append('astropy_helpers.sphinx.ext.automodapi')
40+
self._extensions.append('sphinx_automodapi.automodapi')
4141

4242
def info(self, msg, loc):
4343
self.info.append((msg, loc))
@@ -49,14 +49,14 @@ def warn(self, msg, loc):
4949
ams_to_asmry_str = """
5050
Before
5151
52-
.. automodsumm:: astropy_helpers.sphinx.ext.automodsumm
52+
.. automodsumm:: sphinx_automodapi.automodsumm
5353
:p:
5454
5555
And After
5656
"""
5757

5858
ams_to_asmry_expected = """\
59-
.. currentmodule:: astropy_helpers.sphinx.ext.automodsumm
59+
.. currentmodule:: sphinx_automodapi.automodsumm
6060
6161
.. autosummary::
6262
:p:

sphinx_automodapi/tests/test_utils.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ def test_find_mod_objs():
2020
assert lnms == []
2121

2222
lnms, fqns, objs = find_mod_objs(
23-
'astropy_helpers.sphinx.ext.tests.test_utils', onlylocals=False)
23+
'sphinx_automodapi.tests.test_utils', onlylocals=False)
2424

2525
assert namedtuple in objs
2626

2727
lnms, fqns, objs = find_mod_objs(
28-
'astropy_helpers.sphinx.ext.tests.test_utils', onlylocals=True)
28+
'sphinx_automodapi.tests.test_utils', onlylocals=True)
2929
assert 'namedtuple' not in lnms
3030
assert 'collections.namedtuple' not in fqns
3131
assert namedtuple not in objs

0 commit comments

Comments
 (0)