Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs about Revealer plugin copied from revealer.cc #125

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rocketeerbkw
Copy link

As mentioned in spesmilo/electrum#7358 the website for the Revealer plugin has issues. This PR copies all the data and images from revealer.cc to the electrum docs. Some minor/major grammar changes have been made as well as some larger structure changes. References to Revealer the product have been removed.

@rocketeerbkw
Copy link
Author

I have one bug that I can't figure out the issue/fix. On all pages except the plugins/index page, the links to the revealer pages work correct. But on the plugins/index page the link is missing the plugins subfolder. This causes 404 errors if you first click on Plugins and then you try to click on a Revealer page like How to Use.

Link in sidebar is correct on the home (and all other) page:

Fullscreen_6_23_21__10_59_PM

Link in sidebar (and in the toctree in the body) the link is missing plugins subfolder:

Fullscreen_6_23_21__11_00_PM

@tiagotrs
Copy link
Contributor

Thank you for this!
For me your PR builds without the bug you mentioned - I can click in plugins and then in any sub page with no issues.

@rocketeerbkw rocketeerbkw marked this pull request as ready for review June 25, 2021 06:47
@rocketeerbkw
Copy link
Author

I tried wiping my local setup and starting from scratch, still broken for me. Maybe I'm running the wrong build command sphinx-build -ab html . _build/html?

If you tested it and will sign off, then I guess that's good enough for me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants