#29200: Make more accessible Core Tor documentation ------------------------------------+---------------------------------- Reporter: juga | Owner: antonela Type: defect | Status: new Priority: Medium | Milestone: website redesign Component: Webpages/Website | Version: Severity: Normal | Resolution: Keywords: documentation, ux-team | Actual Points: Parent ID: #24132 | Points: Reviewer: | Sponsor: ------------------------------------+----------------------------------
Comment (by juga): I configured torguts and tor to use [http://www.sphinx-doc.org/en/stable/ Sphinx] for the markdown documentation. The branches: - https://github.com/juga0/torguts/tree/wip_sphinx_doc - https://github.com/juga0/tor/tree/wip_sphinx_doc To see how it looks like: - https://torguts.readthedocs.io/en/latest/ - https://tor-core.readthedocs.io/en/latest/ Note the comments on creating a [https://github.com/juga0/tor/commit/43c70ffdf6bee5f400cda1e526883e0c56ceaa6f #diff-684a0ceb2878d48b19612ca360e277efR76 Sphinx theme for Tor]. I think it would be easy basing it on the Sphinx bootstrap theme. I tried to build the doxygen documentation also with Sphinx using [https://breathe.readthedocs.io/en/latest/ breathe], and i managed to get all in one package (left the branch in https://github.com/juga0/tor/commits/wip_sphinx_doc_doxygen), but it'd require still more work and i'm not sure it's worth. Doxygen itself could be configured to use templates and custom css, maybe that require less work. I can remove those readthedocs domains once it's decided what to do. The documentation could live in readthedocs and have a torproject subdomain that point to it, or it could be deployed in torproject infraestructure having a simple script that pull the repositories every X time and run `make html` in the documentation directory. -- Ticket URL: <https://trac.torproject.org/projects/tor/ticket/29200#comment:8> Tor Bug Tracker & Wiki <https://trac.torproject.org/> The Tor Project: anonymity online
_______________________________________________ tor-bugs mailing list tor-bugs@lists.torproject.org https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs