Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Initial documentation #128

Merged
merged 137 commits into from
Sep 21, 2023
Merged

Initial documentation #128

merged 137 commits into from
Sep 21, 2023

Conversation

francis-clairicia
Copy link
Owner

Documentation

  • Added documentation for overall project

@francis-clairicia
[DOCS] sphinx-quickstart done
5ceb89e
@francis-clairicia
[PROJECT] Updated README.md
a817e93
@francis-clairicia
[PROJECT] README.md: Added codecov badge
95768de
@francis-clairicia
[DOCS] Updated README.md + Added some examples
a1826cc
@francis-clairicia
[DOCS] Improved server examples
dd0a9a7
@francis-clairicia
[DOCS] Added mention about connection state in request handler
29c187f
@francis-clairicia
[DOCS] Examples are ordered
43af36f
@francis-clairicia
[DOCS] README.md: Mention the communication protocol
2ec5460
@francis-clairicia
[DOCS] README.md: Fixed wrong type hinting
fa08cfc
@francis-clairicia
[DOCS] Added "Getting Started" section
370e63c
@francis-clairicia
[DOCS] Added "Tutorial" section (empty) + other minor changes
bb43fe4
@francis-clairicia
[DOCS] Use dedicated todo macro
9091a1c
@francis-clairicia
[DOCS] Updated tutorial namespace + modified copyright
dcb5f4e
@francis-clairicia
[DOCS] README.md: More and more badges :)
e9fbb1d
@francis-clairicia
[DOCS] Added glossary + tutorial start
cd60a90
@francis-clairicia
[DOCS] Updated basic tutorial
75e650a
@francis-clairicia
[DOCS] Updated basic tutorial
c1dd096
@francis-clairicia
[DOCS] Updated basic tutorial + Added precisions to serializer glossary
1710796
@francis-clairicia
[DOCS] Added client code in tutorial
4ab1c71
@francis-clairicia
Merge remote-tracking branch 'origin/main' into docs/initial
bee52f3
@francis-clairicia
[DOCS] Fixes post-merge
ab10c9f
@francis-clairicia
Merge remote-tracking branch 'origin/main' into docs/initial
8ee9a41
@francis-clairicia
[DOCS] README.md: Fixed license after merge
87d8372
@francis-clairicia
[DOCS] README.md: Fixed examples
8f61b86
@francis-clairicia
Merge remote-tracking branch 'origin/main' into docs/initial
cfde8af
@francis-clairicia
[DOCS] Updated basic tutorial: Renamed to echo client/server over tcp
f7cb768
@francis-clairicia
[DOCS] Fixed wrong language link
77dff94
@francis-clairicia
[DOCS] Added UDP endpoint tutorial + Removed 'examples' folder
29d603a
@francis-clairicia
[DOCS] Removed horizontal scrollbars to code blocks
98cd091
@francis-clairicia
[DOCS] Removed a TODO in glossary
9127bcf
@francis-clairicia
[FIX] Little improvement in easynetwork_asyncio.ThreadsPortal
b440527
@francis-clairicia
[FIX] Removed useless imports in doctests
de5439e
@francis-clairicia
[FIX] Renamed a parameter
2af38e2
@francis-clairicia
[FIX] Fixed JSON serializer docstring
288b5e6
@francis-clairicia
[DOCS] how-to guide for protocols: Added beginning
eac7c0b
@francis-clairicia
[DOCS] how-to guide: Improved explanations
ce6a36f
@francis-clairicia
[UPDATE] Reworked converters
ca41f0f
@francis-clairicia
[DOCS] how-to guide for protocols: Finished
60e4d26
@francis-clairicia
[FIX] Fixed async backend API docstring
0fbb173
@francis-clairicia
[UPDATE] Async API: Added timeout parameter to iter_received_packets()
c96ed27
@francis-clairicia
[DOCS] Added how-to guide for TCP clients
6228483
@francis-clairicia
[DOCS] how-to guide for TCP clients: Added concurrency and multithrea…
0a96ab0 
…ding section
@francis-clairicia
[PROJECT] README.md: Modified badges
a1d2ba9
@francis-clairicia
[UPDATE] Servers: Removed bad_request() from request handlers
5b7c3ee
@francis-clairicia
[DOCS] Put all titles to title case
30c9b40
@francis-clairicia
[DOCS] how-to guide for TCP servers: Added beginning
1631f9f
@francis-clairicia
[DOCS] how-to guide for TCP servers: Added full request handler part
7bc1526
@francis-clairicia
[DOCS] how-to guide for TCP servers: Finished
a7ec720
@francis-clairicia
[UPDATE] Request handler: service_init() now takes the server instanc…
7907e45 
…e as parameter
@francis-clairicia
[DOCS] Added links to backend API where this is necessary
aa610de
@francis-clairicia
[PROJECT] Updated dependencies
b9e30e6
@francis-clairicia
[PROJECT] README.md: Something useless
a859a15
@francis-clairicia
[DOCS] Removed 'NotImplementedError' case in functions' documentation
e3cc4be
@francis-clairicia
[DOCS] Fixes post review
2698683
@francis-clairicia
Merge remote-tracking branch 'origin/main' into docs/initial
9de7df6
@francis-clairicia francis-clairicia added the documentation Improvements or additions to documentation label Sep 21, 2023
@francis-clairicia francis-clairicia self-assigned this Sep 21, 2023
@codecov
Copy link

codecov bot commented Sep 21, 2023

Codecov Report

Merging #128 (9de7df6) into main (d5ed719) will not change coverage.
The diff coverage is 100.00%.

Flag Coverage Δ
OS-Linux 87.83% <95.66%> (-0.22%) ⬇️
OS-Windows 87.69% <95.66%> (-0.04%) ⬇️
OS-macOS 87.85% <95.66%> (-0.18%) ⬇️
Py-3.11 99.89% <100.00%> (-0.01%) ⬇️
test-functional 88.01% <95.66%> (-0.22%) ⬇️
test-unit 78.99% <79.95%> (+1.17%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

@francis-clairicia francis-clairicia merged commit f31375c into main Sep 21, 2023
11 checks passed
@francis-clairicia francis-clairicia deleted the docs/initial branch September 21, 2023 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@francis-clairicia francis-clairicia

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@francis-clairicia