Add documentation inline, generate the documentation, host somewhere

Cobular / distest

A library used to do integration testing on discord bots

MIT License

29 stars 8 forks source link

Add documentation inline, generate the documentation, host somewhere #21

Closed Cobular closed 4 years ago

Cobular commented 5 years ago

[ ] Add Documentation (subtask this more)
[x] Generate the Documentation (subtask)
[x] Come up with and implement a hosting solution (subtask)
- Readthedocs? Heroku? Github Pages?
[x] Add tests for documentation
[x] Add autobuilding for documentation

Just put the commits here, we realistically need to do it in this order anyway.

@ALobsterDog you seem to be taking the lead on this, so if you want to add your commits here, that would be great. I'll get started soonly.

Cobular commented 5 years ago

I am aware of the pile of todos I added, I will be turning those into v2.0 milestone issues before merging this, I was just on a plane and couldn't turn them into issues when I ran into the problems.

JosephFKnight commented 5 years ago

I was working on this last night and was having a lot of trouble getting sphinx to import submodules (kept giving errors like "no module called distest.interface" and I can't work out if i'm being dumb or not. You said you got it working? I'll pull this and check it out on my machine later today.

Cobular commented 5 years ago

Sorry about the delay! I'm traveling rn and was super jetlagged the last two days, but I can probably help now. Are you on Windows or Linux? I made some changes to the makefile but not to the .bat file, I can try to translate them over when I get back to a laptop. Also, if you could take a look at the stuff I've written already that would be great, I don't really know if it's very good since I wrote it on a plane while tired lol.

Cobular commented 5 years ago

Should we use readthedocs.io? It seems like the best place to host the docs, since it seems free and directly supports sphinx documentation.

JosephFKnight commented 5 years ago

readthedocs is the best option for sure.

On Thu, Jun 20, 2019, 10:08 AM J Cover notifications@github.com wrote:

Should we use readthedocs.io? It seems like the best place to host the docs, since it seems free and directly supports sphinx documentation.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/JakeCover/distest/pull/21?email_source=notifications&email_token=AK6KUYPCYJXKTULGMCULV2DP3OMQVA5CNFSM4HXE4IBKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODYFWOZY#issuecomment-504063847, or mute the thread https://github.com/notifications/unsubscribe-auth/AK6KUYNPWMTW5RXFLEAM5G3P3OMQVANCNFSM4HXE4IBA .

JosephFKnight commented 5 years ago

https://distest.readthedocs.io/en/feature-add_documentation/

first docs build

Cobular commented 4 years ago

Ok I left this one here for a while, but now it's done.