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

Is it possible to add a simple feedback form on each page of my documentation project as we have copyright info now? #3568

Closed
veenamj opened this issue Feb 1, 2018 · 11 comments

Comments

@veenamj
Copy link

veenamj commented Feb 1, 2018

Details

  • Project URL: community user
  • Build URL (if applicable):
  • Read the Docs username (if applicable):

Expected Result

*We need to add a feedback form at the bottom of each page. So, is there any solution. I could get this #2533 but it is still an open issue.

Actual Result

*Request tips to add a feedback form.

@stsewd
Copy link
Member

stsewd commented Feb 1, 2018

Probably this could be a partial solution for now https://docs.readthedocs.io/en/latest/faq.html#i-want-comments-in-my-docs

@davidfischer
Copy link
Contributor

One possibility is to embed a form directly with a raw directive. The documentation for readthedocs.org used to have one.

Like the disqus plugin @stsewd mentioned, this may be best handled by a 3rd party Sphinx plugin.

@veenamj
Copy link
Author

veenamj commented Feb 4, 2018

Thank you, @stsewd and @davidfischer. I added sphinxcontrib-disqus in the con,.py file's extensions and requirements file. I ran pip install sphinxcontrib-disqus. After running make html (a local build), I get this error -

Extension error:
Could not import extension sphinxcontrib-disqus (exception: No module named sphinxcontrib-disqus)
make: *** [html] Error 1

Pip install went fine though. What would be the fix for this? Thanks in Advance.

@davidfischer
Copy link
Contributor

@veenamj if you have a build URL, that would be helpful.

@veenamj
Copy link
Author

veenamj commented Feb 6, 2018

There is no build URL it is just a local build. I run the command and I get this error as soon as the command is executed?

@davidfischer
Copy link
Contributor

If the build isn't on readthedocs, this doesn't sound like a readthedocs issue. Perhaps open an issue on https://github.com/Robpol86/sphinxcontrib-disqus.

@veenamj
Copy link
Author

veenamj commented Feb 9, 2018

Thanks @davidfischer I will raise it as an issue on https://github.com/Robpol86/sphinxcontrib-disqus.

@veenamj
Copy link
Author

veenamj commented Feb 9, 2018

I haven't posted anything on the disqus site. It looks like we need to create an account on Disqus site and add that to our project as described in http://www.milos.curuvija.com/miscellaneous/sphinx/how_to_integrate_disqus_with_sphinx.html

@davidfischer and @stsewd - This is FYI.

@davidfischer
Copy link
Contributor

I'm going to close this as it doesn't appear to be a RTD issue.

@tinhoang-cerebras
Copy link

I'm also looking for a solution to add a feedback option at the bottom of readthedocs pages. either a stars, thumbs up/down...anyone have luck doing this?

@humitos
Copy link
Member

humitos commented Aug 22, 2023

@tinhoang-cerebras Hi! There is a long conversation on another project about this that you can read to get more ideas: pypa/pip#8784. Read the Docs does not officially support any kind of feedback right now.

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

No branches or pull requests

5 participants