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

Update README.rst #2351

Merged
merged 1 commit into from
Oct 1, 2024
Merged

Update README.rst #2351

merged 1 commit into from
Oct 1, 2024

Conversation

theyashjani
Copy link
Contributor

URL for Server Documentation Updated.
Copy link
Collaborator

@janiversen janiversen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks

@janiversen janiversen merged commit 2109989 into pymodbus-dev:dev Oct 1, 2024
1 check passed
@theyashjani
Copy link
Contributor Author

Hi, @janiversen
If we click on - [ https://pymodbus.readthedocs.io/en/stable/source/readme.html ] => Edit on GitHub,
URL is redirected to - [ https://github.com/pymodbus-dev/pymodbus/blob/dcbcfd7f16fb3be82525bccf9699855a06f900c5/doc/source/readme.rst ]

Instead of - [ https://github.com/pymodbus-dev/pymodbus/blob/dcbcfd7f16fb3be82525bccf9699855a06f900c5/README.rst ]

@janiversen
Copy link
Collaborator

Pull requests are welcome

@theyashjani
Copy link
Contributor Author

Unable to find [ Edit on GitHub ] in readme.html

may be it is in - https://pymodbus.readthedocs.io

image

@janiversen
Copy link
Collaborator

janiversen commented Oct 8, 2024

Basically I am not sure what your problem is, I just tested edit and it worked without problems.

seems you are trying to edit readme.html and not README.rst which is another file. readme.html is solely a link file why would you want to edit that ?

@theyashjani
Copy link
Contributor Author

Basically, i want to change URL for Edit on Github
from current URL - https://github.com/pymodbus-dev/pymodbus/blob/dcbcfd7f16fb3be82525bccf9699855a06f900c5/doc/source/readme.rst

to this new URL - https://github.com/pymodbus-dev/pymodbus/blob/dcbcfd7f16fb3be82525bccf9699855a06f900c5/README.rst

please find reference video

PyModbus.-.A.Python.Modbus.Stack.PyModbus.3.7.2.documentation.-.Google.Chrome.2024-10-08.12-58-55.mp4

@janiversen
Copy link
Collaborator

Just checked https://pymodbus.readthedocs.io/en/latest/source/readme.html

No "edit on github", but clicking "view page sourc" works nicely.

It seems you have other options set. Please jump to github if you want to edit files.

@janiversen
Copy link
Collaborator

The "edit on github" is not something we configure ! and not something we recommend.

the link file points correctly:


.. include:: ../../README.rst

@janiversen
Copy link
Collaborator

janiversen commented Oct 8, 2024

If you look at conf.py, you will see that "edit on github" is not activated", meaning sphinx do not generate the breadcrumb, so that would be the first thing to change.

Secondly you probably need to rename readme.rst to README.rst

good luck, looking forward to see a pull request.

@theyashjani
Copy link
Contributor Author

yes thank you

@theyashjani
Copy link
Contributor Author

hope this works - #2357

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.

2 participants