Skip to content

Commit 5038f0b

Browse files
authored
update sphinx sources for certificates (Azure#7290)
* update sphinx sources for certificates * updating conf to pull in additional sample pattern
1 parent fa91e4e commit 5038f0b

File tree

3 files changed

+18
-16
lines changed

3 files changed

+18
-16
lines changed

doc/sphinx/conf.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,15 @@
2525

2626
# FIX FOR EXAMPLE REFERENCES
2727
REPO_ROOT = os.path.abspath(os.path.join(os.path.abspath(__file__), '..', '..', '..'))
28-
examples_glob_expansion = os.path.join(REPO_ROOT, 'sdk/*/*/examples/**/test*example*.py')
28+
examples_tests_glob_expansion = os.path.join(REPO_ROOT, 'sdk/*/*/examples/**/test*example*.py')
2929
samples_glob_expansion = os.path.join(REPO_ROOT, 'sdk/*/*/tests/**/test*sample*.py')
30+
test_examples_glob_expansion = os.path.join(REPO_ROOT, 'sdk/*/*/tests/**/test*example*.py')
3031

31-
example_files = glob.glob(examples_glob_expansion, recursive=True)
32+
example_tests_files = glob.glob(examples_tests_glob_expansion, recursive=True)
33+
test_examples_files = glob.glob(test_examples_glob_expansion, recursive=True)
3234
samples_files = glob.glob(samples_glob_expansion, recursive=True)
3335

34-
all_files = [os.path.relpath(file, REPO_ROOT) for file in list(set(example_files + samples_files))]
36+
all_files = [os.path.relpath(file, REPO_ROOT) for file in list(set(example_tests_files + test_examples_files + samples_files))]
3537

3638
# now for each package, we need to copy it and write it to the relative path FROM THE CURRENT CWD
3739
for example_file in all_files:
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
certificates.aio package
1+
azure.keyvault.certificates.aio package
22
========================
33

44
Submodules
55
----------
66

7-
certificates.aio.client module
7+
azure.keyvault.certificates.aio.client module
88
------------------------------
99

10-
.. automodule:: certificates.aio.client
10+
.. automodule:: azure.keyvault.certificates.aio.client
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
@@ -16,7 +16,7 @@ certificates.aio.client module
1616
Module contents
1717
---------------
1818

19-
.. automodule:: certificates.aio
19+
.. automodule:: azure.keyvault.certificates.aio
2020
:members:
2121
:undoc-members:
2222
:show-inheritance:
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
1-
certificates package
1+
azure.keyvault.certificates package
22
====================
33

44
Subpackages
55
-----------
66

77
.. toctree::
88

9-
certificates.aio
9+
azure.keyvault.certificates.aio
1010

1111
Submodules
1212
----------
1313

14-
certificates.client module
14+
azure.keyvault.certificates.client module
1515
--------------------------
1616

17-
.. automodule:: certificates.client
17+
.. automodule:: azure.keyvault.certificates.client
1818
:members:
1919
:undoc-members:
2020
:show-inheritance:
2121

22-
certificates.enums module
22+
azure.keyvault.certificates.enums module
2323
-------------------------
2424

25-
.. automodule:: certificates.enums
25+
.. automodule:: azure.keyvault.certificates.enums
2626
:members:
2727
:undoc-members:
2828
:show-inheritance:
2929

30-
certificates.models module
30+
azure.keyvault.certificates.models module
3131
--------------------------
3232

33-
.. automodule:: certificates.models
33+
.. automodule:: azure.keyvault.certificates.models
3434
:members:
3535
:undoc-members:
3636
:show-inheritance:
@@ -39,7 +39,7 @@ certificates.models module
3939
Module contents
4040
---------------
4141

42-
.. automodule:: certificates
42+
.. automodule:: azure.keyvault.certificates
4343
:members:
4444
:undoc-members:
4545
:show-inheritance:

0 commit comments

Comments
 (0)