fava icon indicating copy to clipboard operation
fava copied to clipboard

View in-app help on fava public website

Open alexjj opened this issue 5 years ago • 3 comments

Would be nice to be able to review the in-app help but via the fava website.

alexjj avatar Jan 26 '20 20:01 alexjj

Are you willing to provide a PR?

yagebu avatar Feb 01 '20 10:02 yagebu

I would like to try doing this. Is it basically done using all Markdown Files from /src/fava/help ?

It would be nice if you could give me a little bit more information about how you made your gh-pages site.

Edit: From what I found out you are using tox and sphinx to create the website with the MAKEFILE?

ueberBrot avatar May 31 '20 09:05 ueberBrot

Is it basically done using all Markdown Files from /src/fava/help ?

The Markdown files currently expect to be embedded in Fava, so they can link to Fava's reports (which is done in two places). Also, the url_for is used to link between the help pages. That would have to be implemented a bit differently for the website.

From what I found out you are using tox and sphinx to create the website with the MAKEFILE?

Yes, Sphinx is the main tool to build the website. There's just a little script that runs before to generate the sources for the API documentation.

yagebu avatar Jun 07 '20 15:06 yagebu

I'll close this pretty stale issue - if someone wants to work on this, a PR would still be welcome.

yagebu avatar May 26 '23 14:05 yagebu