Start sphinx docs

[bollwyvl]

References

• Extensive installation instructions? #169 install docs started
• Refactor LSPConnection, ConnectionManager #165 as-is architecture started
  • will probably upstream this there so i can start documenting what the proposed changes might be

Code changes

Goals for this PR:

• collect envs/reqs into a folder
  • Adds new (nb)sphinx env/requirements
• Adds doc script
• Handle some initial documentation tasks
• icon
• review some best practices
  • https://www.divio.com/blog/documentation/
• Add docs to automation
  • integrity
  • linting
  • CI
• integrate existing content:
  • ROADMAP
  • README
  • CONTRIBUTNG
  • LANGUAGESERVERS
  • EXTENDING

(Maybe) non-goals for this PR:

• add readthedocs
• add screenshots/gifs from acceptance tests

User-facing changes

None, yet

Backwards-incompatible changes

None, yet

Chores

• linted
• tested
• documented
• changelog entry

[bollwyvl]

Working on the docs locally with autoreload:

[bollwyvl]

This is mostly wired up now, and at least generates the docs on azure. I've also updated the architecture pieces a fair amount (i.e. documented #165 here, rather than on that branch), and spent a little more time on the install piece. There are a number of outstanding issues, of course, but it might make sense to merge and move forward more incrementally: it's not ready to start publishing on readthedocs, and indeed, we may not want to do so, if we want to use screenshots from the acceptance tests in the docs.

Some future, non-content thoughts:

• test the links with e.g. pytest-check-links
• apply some more rigorous formatting and linting with e.g. prenotebook

[krassowski]

Incremental progress is the best kind of progress!

[krassowski]

nice catch!

[krassowski]

Waiting for the CI to pass before I merge.

[krassowski]

The tests like to fail on master...