Skip to content

Commit 69106f0

Browse files
author
Maximilian Karl
authored
9 documentation (#46)
Add documentation on readthedocs
1 parent 31f7f37 commit 69106f0

File tree

16 files changed

+61
-1706
lines changed

16 files changed

+61
-1706
lines changed

‎README.md‎

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,30 +12,30 @@ The package implements Python functions for
1212

1313
```
1414
data <- Root directory given as parameter
15-
|-- My_Github_Repository_0 <- Repository name
16-
| |- Repo.json <- Json file containing user and repo name
17-
| |- Issues
18-
| │ |- pdIssuesComments.p
19-
| │ |- pdIssuesEvents.p
20-
| │ |- pdIssues.p
21-
| │ |- pdIssuesReactions.p
22-
| |- PullRequests
23-
| │ |- pdPullRequestsComments.p
24-
| │ |- pdPullRequestsEvents.p
25-
| │ |- pdPullRequests.p
26-
| │ |- pdPullRequestsReactions.p
27-
| │ |- pdPullRequestsReviews.p
28-
| |- Users.p
29-
| |- Versions
30-
| │ |- pdCommits.p
31-
| │ |- pdEdits.p
32-
| │ |- pdBranches.p
33-
| │ |- pVersions.db
34-
| │ |- repo <- Repository clone
35-
| │ │ |- ..
36-
| |- Workflows
37-
| |- pdWorkflows.p
38-
|-- My_Github_Repository_1
15+
├── My_Github_Repository_0 <- Repository name
16+
│ ├── Repo.json <- Json file containing user and repo name
17+
│ ├── Issues
18+
│ │ ├── pdIssuesComments.p
19+
│ │ ├── pdIssuesEvents.p
20+
│ │ ├── pdIssues.p
21+
│ │ └── pdIssuesReactions.p
22+
│ ├── PullRequests
23+
│ │ ├── pdPullRequestsComments.p
24+
│ │ ├── pdPullRequestsEvents.p
25+
│ │ ├── pdPullRequests.p
26+
│ │ ├── pdPullRequestsReactions.p
27+
│ │ └── pdPullRequestsReviews.p
28+
│ ├── Users.p
29+
│ ├── Versions
30+
│ │ ├── pdCommits.p
31+
│ │ ├── pdEdits.p
32+
│ │ ├── pdBranches.p
33+
│ │ ├── repo <- Repository clone
34+
│ │ │ ├── ..
35+
│ │ └── Versions.db
36+
│ └── Workflows
37+
│ └── pdWorkflows.p
38+
├── My_Github_Repository_1
3939
...
4040
```
4141
The internal structure and relations of the data frames are included in the project's [wiki](https://github.com/TUBAF-IFI-DiPiT/github2pandas/wiki).
@@ -61,9 +61,10 @@ GitHub token is required for use, which is used for authentication. The [website
6161
| Issues | [Issue_Example.ipynb](https://github.com/TUBAF-IFI-DiPiT/github2pandas/blob/main/notebooks/Issues_Example.ipynb) | |
6262
| Pull-Requests | [Pull_Requests_Example.ipynb](https://github.com/TUBAF-IFI-DiPiT/github2pandas/blob/main/notebooks/Pull_Requests_Example.ipynb)| |
6363

64-
The documentation of the module is available at [https://github2pandas.readthedocs.io/en/9-documentation/](https://github2pandas.readthedocs.io/en/9-documentation/).
6564

66-
# For Developers
65+
The documentation of the module is available at [https://github2pandas.readthedocs.io/](https://github2pandas.readthedocs.io/).
66+
67+
# For Contributors
6768

6869
Naming conventions: https://namingconvention.org/python/
6970

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
# Add any paths that contain templates here, relative to this directory.
4141
templates_path = ['_templates']
4242
# The suffix of source filenames.
43-
source_suffix = [".rst", ".md"]
43+
source_suffix = [".rst",".md"]
4444

4545
# List of patterns, relative to source directory, that match files and
4646
# directories to ignore when looking for source files.

‎docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Welcome to github2pandas's documentation!
88

99
.. toctree::
1010
:maxdepth: 1
11-
11+
1212
readme
1313
github2pandas
1414
changes

‎docs/readme.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
1-
Readme File
2-
===========
31

42
.. mdinclude:: ../README.md

‎docs/requirements.txt‎

Lines changed: 18 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,20 @@
11
# Defining the exact version will make sure things don't break
2-
sphinx==3.4.3
3-
sphinx_rtd_theme==0.5.1
4-
readthedocs-sphinx-search==0.1.0
2+
pygit2==1.5.0
3+
pyyaml==5.4.1
4+
requests==2.25.1
5+
datetime==4.3
6+
pygithub==1.54.1
7+
argparse==1.4.0
8+
pydriller==1.15.2
9+
git2net==1.4.10
10+
pysqlite3==0.4.6
11+
selenium==3.141.0
12+
python-dotenv==0.17.0
13+
pandas==1.2.4
14+
jupyter==1.0.0
15+
sphinx==3.5.4
516
m2r2==0.2.7
6-
argon2-cffi==20.1.0,
7-
argparse==1.4.0,
8-
async-generator==1.10; python_version >= '3.5',
9-
attrs==20.3.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3',
10-
babel==2.9.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3',
11-
backcall==0.2.0,
12-
bleach==3.3.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4',
13-
cached-property==1.5.2,
14-
certifi==2020.12.5,
15-
cffi==1.14.5,
16-
chardet==4.0.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4',
17-
click==7.1.2; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4',
18-
datetime==4.3,
19-
decorator==5.0.5; python_version >= '3.5',
20-
defusedxml==0.7.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4',
21-
deprecated==1.2.12; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3',
22-
docutils==0.17; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4',
23-
entrypoints==0.3; python_version >= '2.7',
24-
git2net==1.4.10,
25-
gitdb==4.0.7; python_version >= '3.4',
26-
gitpython==3.1.14; python_version >= '3.4',
27-
human-id==0.1.0.post3,
28-
idna==2.10; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3',
29-
imagesize==1.2.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3',
30-
ipykernel==5.5.3; python_version >= '3.5',
31-
ipython==7.22.0; python_version >= '3.3',
32-
ipython-genutils==0.2.0,
33-
ipywidgets==7.6.3,
34-
jedi==0.18.0; python_version >= '3.6',
35-
jinja2==2.11.3; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4',
36-
jsonschema==3.2.0,
37-
jupyter==1.0.0,
38-
jupyter-client==6.1.12; python_version >= '3.5',
39-
jupyter-console==6.4.0; python_version >= '3.6',
40-
jupyter-core==4.7.1; python_version >= '3.6',
41-
jupyterlab-pygments==0.1.2,
42-
jupyterlab-widgets==1.0.0; python_version >= '3.6',
43-
lizard==1.17.7,
44-
m2r2==0.2.7,
45-
markupsafe==1.1.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3',
46-
mistune==0.8.4,
47-
nbclient==0.5.3; python_full_version >= '3.6.1',
48-
nbconvert==6.0.7; python_version >= '3.6',
49-
nbformat==5.1.3; python_version >= '3.5',
50-
nest-asyncio==1.5.1; python_version >= '3.5',
51-
notebook==6.3.0; python_version >= '3.6',
52-
numpy==1.20.2; python_version >= '3.7',
53-
packaging==20.9; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3',
54-
pandas==1.2.3,
55-
pandocfilters==1.4.3,
56-
parso==0.8.2; python_version >= '3.6',
57-
pathpy2==2.2.0; python_version >= '3.5',
58-
pexpect==4.8.0; sys_platform != 'win32',
59-
pickleshare==0.7.5,
60-
prometheus-client==0.10.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3',
61-
prompt-toolkit==3.0.18; python_full_version >= '3.6.1',
62-
ptyprocess==0.7.0; os_name != 'nt',
63-
pycparser==2.20; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3',
64-
pydriller==1.15.2,
65-
pygit2==1.5.0,
66-
pygithub==1.54.1,
67-
pygments==2.8.1; python_version >= '3.5',
68-
pyjwt==1.7.1,
69-
pyparsing==2.4.7; python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3',
70-
pypiwin32==223; sys_platform == 'win32',
71-
pyrsistent==0.17.3; python_version >= '3.5',
72-
pysqlite3==0.4.6,
73-
python-dateutil==2.8.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3',
74-
python-dotenv==0.17.0,
75-
python-levenshtein==0.12.2,
76-
pytz==2021.1,
77-
pyyaml==5.4.1,
78-
pyzmq==22.0.3; python_version >= '3.6',
79-
qtconsole==5.0.3; python_version >= '3.6',
80-
qtpy==1.9.0,
81-
requests==2.25.1,
82-
scipy==1.6.2; python_version < '3.10' and python_version >= '3.7',
83-
selenium==3.141.0,
84-
send2trash==1.5.0,
85-
six==1.15.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3',
86-
smmap==4.0.0; python_version >= '3.5',
87-
snowballstemmer==2.1.0,
88-
sphinx==3.5.3,
89-
sphinxcontrib-applehelp==1.0.2; python_version >= '3.5',
90-
sphinxcontrib-devhelp==1.0.2; python_version >= '3.5',
91-
sphinxcontrib-htmlhelp==1.0.3; python_version >= '3.5',
92-
sphinxcontrib-jsmath==1.0.1; python_version >= '3.5',
93-
sphinxcontrib-qthelp==1.0.3; python_version >= '3.5',
94-
sphinxcontrib-serializinghtml==1.1.4; python_version >= '3.5',
95-
terminado==0.9.4; python_version >= '3.6',
96-
testpath==0.4.4,
97-
tornado==6.1; python_version >= '3.5',
98-
tqdm==4.60.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3',
99-
traitlets==5.0.5; python_version >= '3.7',
100-
urllib3==1.26.4; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4',
101-
wcwidth==0.2.5,
102-
webencodings==0.5.1,
103-
widgetsnbextension==3.5.1,
104-
wrapt==1.12.1,
105-
zope.interface==5.3.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4',
17+
pypiwin32==223; sys_platform == 'win32'
18+
human-id==0.1.0.post3
19+
psutil==5.8.0
20+
sphinx-rtd-theme==0.5.2

0 commit comments

Comments
 (0)