search

markstory / sphinxcontrib-phpdomain

A PHP domain for sphinx. Allows you to annotate PHP objects in your sphinx docs.
Other
19 stars 15 forks source link

Mistake in documentation #41

Closed stevespages closed 1 year ago

stevespages commented 1 year ago

In your PHP Domain for Sphinx documentation you show some source code (This is source:). Then you show Result. Both of these look identical. I am assuming you meant to show something different for Result as what you have shown looks like source ie. reStructuredText

stevespages commented 1 year ago

I have just seen your documentation at https://pythonhosted.org/sphinxcontrib-phpdomain/ where the Result looks great. So, it is just a problem with the GitHub page.

markstory commented 1 year ago

So, it is just a problem with the GitHub page.

I'm not sure there is much I can do about that without causing problems in other places the documentation is published.

n-peugnet commented 1 year ago

Maybe the example should only be in the doc and not in the README, as it will always be broken outside of a Sphinx doc with phpdomain enabled. The README could only provide a link to the corresponding page of the doc.

markstory commented 1 year ago

Leaving the rendered examples out of the README sounds reasonable to me.