Adds docs for readthedocs

[qduk]

This now dynamically pulls from the README for the respective section. Was also able to fix the decorated functions and use invoke instead of make. Now, in the docs folder you can you just run invoke html and it'll build your html files.

Edit:
To create files locally.

1. Install requirements under docs folder `pip install -r docs/requirements.txt
2. Run invoke html in project root.
3. File will be generated in docs/build

[itdependsnetworks]

Where is config?

[qduk]

The config for asn? It lives in its own folder under source/netutils/asn.

[itdependsnetworks]

like should there be an config/index?

[qduk]

Totally missed those. I added a general configs tab. We could break it up how the code is with each file having its own tab under config. Let me know what you think and I can change it if need be.

[itdependsnetworks]

Good stuff!

We should add a test or two.

• Ensure it runs and compiles.
• I think the end-line/start-line is great, but suspect that will move over time, can compare it against current standard.
• See if there is a way to verify that all files are considered.

[qduk]

@itdependsnetworks I added a few tests. I'm not sure if they should live in the unit tests folder or not but they check the following,

• Sphinx builds without any errors
• Checks that there is a folder in docs/source/netutils for a given python file
• Each folder contains an index.

There is a PR that would've allowed me to use the start-before and end-after directives which would've been easier to break the README into sections but it was never merged into the project. So the line directives seemed like the best next bet.

[itdependsnetworks]

I think it makes sense to call clean_docs here, just ensure it is done idempotently.

[qduk]

Updated

[itdependsnetworks]

Can you add a start/end line test here? Something to ensure that the current start and end line remain the same throughout updates. This will ensure that if the readme is modified, that the tests will fail. If the start or end line change, they simply need to modify the tests.

[qduk]

Added tests to check for that. Let me know what you think.

[jeffkala]

Does it make sense to keep these?, being that they're just commented out?

[qduk]

Took them out. Good call. I believe Sphinx makes it that way when you start with it's template. Thanks Jeff.

[itdependsnetworks]

Can we just create a data structure, and a single test. Something like

[
  {
    "overview": {
      "start-line": 10,
      "start-val": "# netutils\n",
      "end-line": 32,
      "end-value": "* VLANs - Provide the ability to convert configuration into lists or lists into configuration.\n"
    }
  },
  {
    "attribution": {
      "start-line": "NN",
      "start-val": "TEXT",
      "end-line": "NN",
      "end-value": "TEXT"
    }
  }
]

Even better would be if you can dynamically find the line numbers, that are shown here, as an example:

   :start-line: 131   :end-line: 178

[qduk]

Updated. I created an issue for parsing the start and end line so I can get that handled down the road.