-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Scapy docs massive cleanup #1865
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.
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
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1865 +/- ##
==========================================
+ Coverage 80.56% 83.69% +3.13%
==========================================
Files 180 185 +5
Lines 40906 42479 +1573
==========================================
+ Hits 32954 35553 +2599
+ Misses 7952 6926 -1026
|
Codecov Report
@@ Coverage Diff @@
## master #1865 +/- ##
==========================================
+ Coverage 85.85% 85.86% +0.01%
==========================================
Files 187 187
Lines 42773 42781 +8
==========================================
+ Hits 36723 36736 +13
+ Misses 6050 6045 -5
|
I’ve rebased to fix the conflicts |
As far as I remember, v2.3.3 was the latest version to support Python 2.5. |
@epozzobon made a script to convert |
Many hands on examples are similar to unit tests. Do you think, it would be possible to generate hands on examples from I could imagine something like a special tag on a unit test step. This will indicate a new script to export this test as example snippet. The test name could than be used as headline. Explanation can be between the code as comments. |
@polybassa I like our idea of using the unit tests for the documentation! |
The easiest way would probably be a script, which checks for a specific tag and then copies the related unit test as |
Can I merge this? |
Should be mergeable ! |
Massive doc overhaul:
Advanced usage
into separate layer-specific files:toctree:
).svg
files + replace oldUsage
screenshot by fancy SVG animation inIntroduction
Introduction
)#scapy.contrib.*
SVGs animation are light, well-supported (except on Microsoft Edge, but it isn't used much, and will be soon switching to a Chromium implementation which supports it), and make the doc much more readable. It was first used in the Automative doc, and it's a great idea. I think we could try to implement them more often.
Screenshots