Skip to content
This repository was archived by the owner on Dec 17, 2024. It is now read-only.

Commit 69f2592

Browse files
committed
re
1 parent 37ecf6a commit 69f2592

File tree

4 files changed

+49
-50
lines changed

4 files changed

+49
-50
lines changed

PYPI.rst

Lines changed: 40 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,7 @@ This package can be used directly as a python file or as a python library.
1818
Installation
1919
------------
2020

21-
For direct use:
22-
23-
.. code-block:: bash
24-
25-
git clone https://github.com/TodoLodo2089/cod-python-api.git
26-
27-
As a python library using `pip`_:
21+
Install cod-api library using `pip`_:
2822

2923
.. code-block:: bash
3024
@@ -54,7 +48,7 @@ Login with your sso token
5448
api.login('Your sso token')
5549
5650
You sso token can be found by longing in at `callofduty`_, opening dev tools (ctr+shift+I),
57-
going to Applications > Storage > Cookies > :samp:`https://callofduty.com`, filter to search 'ACT_SSO_COOKIE' and
51+
going to Applications > Storage > Cookies > https://callofduty.com, filter to search 'ACT_SSO_COOKIE' and
5852
copy the value
5953

6054
.. _callofduty: https://my.callofduty.com/
@@ -73,70 +67,71 @@ and following are available sub classes
7367

7468
To retrieve detailed description of each subclass `__doc__` (docstring) of each sub class can be called as shown below:
7569

76-
.. tabs::
70+
`ColdWar`
7771

78-
.. tab:: ColdWar
72+
.. code-block:: python
7973
80-
.. code-block:: python
74+
from cod_api import API
8175
82-
from cod_api import API
76+
api = API()
8377
84-
api = API()
78+
# print out the docstring
79+
print(api.ColdWar)
8580
86-
# print out the docstring
87-
print(api.ColdWar)
81+
`ModernWarfe`
8882

89-
.. tab:: ModernWarfare
83+
.. code-block:: python
9084
91-
.. code-block:: python
85+
from cod_api import API
9286
93-
from cod_api import API
87+
api = API()
9488
95-
api = API()
89+
# print out the docstring
90+
print(api.ModernWarfare)
9691
97-
# print out the docstring
98-
print(api.ModernWarfare)
92+
`Vanguard`
9993

100-
.. tab:: Vanguard
94+
.. code-block:: python
10195
102-
.. code-block:: python
96+
from cod_api import API
10397
104-
from cod_api import API
98+
api = API()
10599
106-
api = API()
100+
# print out the docstring
101+
print(api.Vanguard)
107102
108-
# print out the docstring
109-
print(api.Vanguard)
103+
`Warzone`
110104

111-
.. tab:: Warzone
105+
.. code-block:: python
112106
113-
.. code-block:: python
107+
from cod_api import API
114108
115-
from cod_api import API
109+
api = API()
116110
117-
api = API()
111+
# print out the docstring
112+
print(api.Warzone)
118113
119-
# print out the docstring
120-
print(api.Warzone)
114+
`Me`
121115

122-
.. tab:: Me
116+
.. code-block:: python
123117
124-
.. code-block:: python
118+
from cod_api import API
125119
126-
from cod_api import API
120+
api = API()
127121
128-
api = API()
122+
# print out the docstring
123+
print(api.Me)
129124
130-
# print out the docstring
131-
print(api.Me)
125+
`Misc`
132126

133-
.. tab:: Misc
127+
.. code-block:: python
134128
135-
.. code-block:: python
129+
from cod_api import API
136130
137-
from cod_api import API
131+
api = API()
138132
139-
api = API()
133+
# print out the docstring
134+
print(api.Misc)
140135
141-
# print out the docstring
142-
print(api.Misc)
136+
.. image:: https://github.com/executablebooks/sphinx-tabs/workflows/continuous-integration/badge.svg?branch=master
137+
:target: https://github.com/TodoLodo2089/cod-python-api.git

conf.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
extensions = [
2-
'sphinx_code_tabs'
3-
]
1+
extensions = ['sphinx_tabs.tabs']
2+
sphinx_tabs_valid_builders = ['linkcheck']
3+
sphinx_tabs_disable_tab_closing = True
4+
def setup(app):
5+
app.add_lexer('alias', MyCustomLexer())
6+
sphinx_tabs_disable_css_loading = True

reuirements_dev.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ enum34
33
requests
44
twine
55
urllib3
6-
uuid
6+
uuid
7+
sphinx-tabs

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from setuptools import setup
22

3-
requirements = ["asyncio", "requests", "uuid", "urllib3", "enum34"]
3+
requirements = ["asyncio", "requests", "uuid", "urllib3", "enum34", "sphinx-tabs"]
44

55
setup(
66
name="cod_api",

0 commit comments

Comments
 (0)