convert documentation and website to Sphinx

[anarcat]

The follow commits convert the README and the whole website into
Sphinx/ReStrucuredText markup (from Markdown and HTML, respectively)
using Pandoc and manual modifications.

The website required some editing because there was some overlap
between the site and the README file. I have tried to retain all the
information except when there were clear duplicates. The only such
case I have found is in the "build" section of the webpage, which
duplicated the README, and the latter was kept.

I also tried to keep the README intact so that users can read it as
such from the source.

Closes: #65

[anarcat]

alright, so a preview of this is available here:

https://anarcat-f3.readthedocs.io/en/rst/

to put it really online, we'd need to create a new "f3" project that pulls from this repository instead of my fork. i can create that project on RTD but you would at least need to create an account there so I can grant you admin access as well. you would need to configure hooks in the github repo so it "pings" the RTD project to trigger rebuilds when the repository changes here.

let me know what you think...

[anarcat]

bad news: the https://f3.readthedocs.io/ namespace is already taken by another project, the unrelated f3 package. maybe the project could be named "fight-fake-flash"?

[AltraMayor]

I prefer to name the project "fight-flash-fraud".

I created the username "AltraMayor" on RTD.

[anarcat]

On 2017-11-16 20:35:18, Michel Machado wrote: I prefer to name the project "fight-flash-fraud".

Alright, the project is here now with the docs derived from the master branch: https://fight-flash-fraud.readthedocs.io/en/latest/

I created the username "AltraMayor" on RTD.

I added you to the project. The control panel is here: https://readthedocs.org/projects/fight-flash-fraud/ You still need to configure the Integration from GitHub.

[anarcat]

I guess you also should change the "homepage" url in the github project as well, and make a redirection from http://oss.digirati.com.br/f3/

[AltraMayor]

I'll look at that once I finally release version 7. For now, I'm keeping the current page since version 7 is still missing one more improvement before release.

Once again, thank you for this contribution. It has enabled the community to help me with creating and keeping the documentation updated.

[AltraMayor]

The webhook should be all set now.

[anarcat]

I'll look at that once I finally release version 7. For now, I'm keeping the current page since version 7 is still missing one more improvement before release.

I'm not sure I understand here.. But it's as you wish really. :)

Once again, thank you for this contribution. It has enabled the community to help me with creating and keeping the documentation updated.

No problem... once this was decided, the switch wasn't so hard... Hopefully the community will answer positively as well!