doc conversions over to github.io/markdown

actus10 · Aug 12, 2021 · a7a8264 · a7a8264
1 parent 3c0d9d4
commit a7a8264
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 279 deletions.
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1 +1,23 @@
 # Changelog
+
+## 1.9.5
+**[2021-02-07]** 
+
+- New example showing how to process truncated DNS packets (examples/print_dns_truncated.py).
+- Corrected typo in BGP.notification attribute.
+- BGP.Update.Attribute.MPReachNLRI.SNPA now inherits from dpkt.Packet.
+- Byteorder is now specified when packing GRE optional fields.
+- \#517: Improvement to Radiotap class, supporting multi-byte and misaligned flags fields. Endianness is now enforced.
+- Github issue template added for bug reporting.
+- Compliance with flake8 formatting.
+- asn1.py::utctime method now returns time in UTC, instead of local.
+- Allow multiple InterfaceDescriptionBlocks with pcapng.Writer.
+- SCTP decoder DATA chunk padding aligned to 4-bytes, and improved handling of .data field.
+- IEEE80211 DELBA frame now works on big and little-endian architectures.
+- Introduce compat.ntole which converts from network byte order to little-endian byte order, regardless of host endianness.
+- Ethernet class now attempts to unpack the padding and trailer if present.
+- Added anonymous property to cipher suites, which returns True if the cipher suite starts with 'anon'.
+- Added pfs (Perfect Forward Secrecy) and aead (Authenticated Encryption with Additional Data) properties to cipher suites.
+- Added old CHACHA20-POLY1305 related cipher suites to TLS CipherSuite list.
+- Remove redundant num_compression_methods from TLSClientHello
+- Testing improved from 90% coverage to over 99%.
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/index.md b/docs/index.md
@@ -8,39 +8,21 @@ The dpkt project is a python module for fast, simple packet parsing, with defini
 pip install dpkt
 ```
 
-### Documentation
+### Examples
+- [Print Packets](print_packets.md)
+- [Print ICMP](print_icmp.md)
+- [Print HTTP](print_http_requests.md)
 
-<https://kbandla.github.io/dpkt/>
-
-### Recent Stuff 
-
-**[2021-02-07]** 
-Released 1.9.5, thanks a bunch to all contributors but mostly to @crocogorical for doing most of the work :)
-
-1.9.5 Changelog:
-
-- New example showing how to process truncated DNS packets (examples/print_dns_truncated.py).
-- Corrected typo in BGP.notification attribute.
-- BGP.Update.Attribute.MPReachNLRI.SNPA now inherits from dpkt.Packet.
-- Byteorder is now specified when packing GRE optional fields.
-- \#517: Improvement to Radiotap class, supporting multi-byte and misaligned flags fields. Endianness is now enforced.
-- Github issue template added for bug reporting.
-- Compliance with flake8 formatting.
-- asn1.py::utctime method now returns time in UTC, instead of local.
-- Allow multiple InterfaceDescriptionBlocks with pcapng.Writer.
-- SCTP decoder DATA chunk padding aligned to 4-bytes, and improved handling of .data field.
-- IEEE80211 DELBA frame now works on big and little-endian architectures.
-- Introduce compat.ntole which converts from network byte order to little-endian byte order, regardless of host endianness.
-- Ethernet class now attempts to unpack the padding and trailer if present.
-- Added anonymous property to cipher suites, which returns True if the cipher suite starts with 'anon'.
-- Added pfs (Perfect Forward Secrecy) and aead (Authenticated Encryption with Additional Data) properties to cipher suites.
-- Added old CHACHA20-POLY1305 related cipher suites to TLS CipherSuite list.
-- Remove redundant num_compression_methods from TLSClientHello
-- Testing improved from 90% coverage to over 99%.
+### Documentation
+- [DPKT Key Concepts for Creating Parsers](creating_parsers.md)
+- [Changelog](changelog.md)
+- [Authors](authors.md)
+- [Contributing](contributing.md)
+- [Project Plans (TBD)](plans.md)
+- [Admin Notes](admin_notes.md)
 
 ## About
-This code is based on [dpkt code](https://code.google.com/p/dpkt/) lead by Dug Song and is now being maintained and improved by an extended set of 
-[contributors](https://dpkt.readthedocs.org/en/latest/authors.html) and [developers] (https://github.com/kbandla/dpkt/graphs/contributors)
+This code is based on [dpkt code](https://code.google.com/p/dpkt/) lead by Dug Song and is now being maintained and improved by an extended set of [developers] (https://github.com/kbandla/dpkt/graphs/contributors).
 
 ## LICENSE
 

diff --git a/docs/installation.md b/docs/installation.md
diff --git a/docs/plans.md b/docs/plans.md
@@ -1,9 +1,3 @@
 # Development plans
 
-## Current plans
-
-  - Be Awesome
-
-## Future plans
-
-  - Maintain the Awesome
+TBD: Insert Stuff Here
diff --git a/docs/requirements.txt b/docs/requirements.txt