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 doc for repl #910

Merged
merged 1 commit into from
May 26, 2022
Merged

Update doc for repl #910

merged 1 commit into from
May 26, 2022

Conversation

janiversen
Copy link
Collaborator

seems "make html" in ./doc have not been run for a while, since it refers to a non existing file repl/main

Updated to document client/server as sub packages.

@janiversen
Copy link
Collaborator Author

@dhoomakethu any thoughts ?

@sonarcloud
Copy link

sonarcloud bot commented May 24, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@dhoomakethu
Copy link
Contributor

I am travelling with limited network access, will check this once I am back in town (over the weekend)

@dhoomakethu dhoomakethu merged commit 4b3e124 into pymodbus-dev:dev May 26, 2022
@dhoomakethu
Copy link
Contributor

The following documents are to be updated

/Users/sanjay/repo/pymodbus/doc/source/example/asynchronous_processor.rst:4: WARNING: Include file '/Users/sanjay/repo/pymodbus/examples/common/asynchronous_processor.py' not found or reading it failed
/Users/sanjay/repo/pymodbus/doc/source/example/asynchronous_server.rst:4: WARNING: Include file '/Users/sanjay/repo/pymodbus/examples/common/asynchronous_server.py' not found or reading it failed
/Users/sanjay/repo/pymodbus/doc/source/example/dbstore_update_server.rst:4: WARNING: Include file '/Users/sanjay/repo/pymodbus/examples/common/dbstore_update_server.py' not found or reading it failed
/Users/sanjay/repo/pymodbus/doc/source/example/gui_common.rst:4: WARNING: Include file '/Users/sanjay/repo/pymodbus/examples/gui/gui_common.py' not found or reading it failed
/Users/sanjay/repo/pymodbus/doc/source/example/modbus_scraper.rst:4: WARNING: Include file '/Users/sanjay/repo/pymodbus/examples/contrib/modbus_scraper.py' not found or reading it failed
/Users/sanjay/repo/pymodbus/doc/source/example/sunspec_client.rst:4: WARNING: Include file '/Users/sanjay/repo/pymodbus/examples/contrib/sunspec_client.py' not found or reading it failed
/Users/sanjay/repo/pymodbus/doc/source/example/synchronous_server.rst:4: WARNING: Include file '/Users/sanjay/repo/pymodbus/examples/common/synchronous_server.py' not found or reading it failed
/Users/sanjay/repo/pymodbus/doc/source/example/updating_server.rst:4: WARNING: Include file '/Users/sanjay/repo/pymodbus/examples/common/updating_server.py' not found or reading it failed
WARNING: autodoc: failed to import module 'asyncio' from module 'pymodbus.client.asynchronous'; the following exception was raised:
No module named 'pymodbus.client.asynchronous.asyncio'
/Users/sanjay/.virtualenvs/pymodbus/lib/python3.8/site-packages/pymodbus/client/asynchronous/factory/tcp.py:docstring of pymodbus.client.asynchronous.factory.tcp.get_factory:4: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/sanjay/.virtualenvs/pymodbus/lib/python3.8/site-packages/pymodbus/client/asynchronous/factory/udp.py:docstring of pymodbus.client.asynchronous.factory.udp.get_factory:4: WARNING: Field list ends without a blank line; unexpected unindent.
WARNING: autodoc: failed to import module 'internal' from module 'pymodbus'; the following exception was raised:

@janiversen janiversen deleted the PR_correct_doc branch May 26, 2022 06:01
@janiversen
Copy link
Collaborator Author

Done in #911 (which are merged).

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants