#373 Include documentation_helpers in module

[arjxn-py]

This Pull Request aims to fix #373 by including documentation_helpers in the submodule ragna._docs.
It'll help us to -

• Not to explicitly include extra files in the documentation that need to be included through sys.path, reducing the noise in the example
• Help users to run tutorials if they have ragna installed
• Have the advantage of not being bound to backward compatibility even after we adopt semantic versioning given that the module is private.

cc: @pmeier

[arjxn-py]

I find it strange that after I moved documentation_helpers to ragna._docs, I'm getting this error -

Traceback (most recent call last):
  File "/mnt/d/Arjun/ragna/docs/tutorials/gallery_python_api.py", line 19, in <module>
    import ragna._docs.documentation_helpers as documentation_helpers
  File "/mnt/d/Arjun/ragna/ragna/_docs/documentation_helpers.py", line 12, in <module>
    from ragna.deploy import Config
  File "/mnt/d/Arjun/ragna/ragna/deploy/__init__.py", line 8, in <module>
    from ._config import Config
  File "/mnt/d/Arjun/ragna/ragna/deploy/_config.py", line 133, in <module>
    class Config(ConfigBase):
  File "/mnt/d/Arjun/ragna/ragna/deploy/_config.py", line 139, in Config
    default_factory=ragna.local_root
AttributeError: module 'ragna' has no attribute 'local_root'

Which to me seems to be unrelated to the changes at the moment & I've also tried to fix it and found that local_root has been properly imported in ragna/__init__.py hence it should be an attribute.

I'd be really glad to have your input on this, until then I'm on it 🙂

[arjxn-py]

I find it strange that after I moved documentation_helpers to ragna._docs, I'm getting this error

It has been fixed since now I'm importing local_path directly from ragna._utils. Thanks

[pmeier]

Thanks @arjxn-py. I left a few comments.

[arjxn-py]

Hi @pmeier, sorry to ping you. Just wanted to have a bit of your input on this while moving forward. Thanks.

[pmeier]

Thanks Arjun for the PR! I took the liberty and did the final minor cleanup to avoid lengthy back and forth.

[arjxn-py]

Thanks Arjun for the PR! I took the liberty and did the final minor cleanup to avoid lengthy back and forth.

Thanks, I'm really grateful.
I'd be really happy to have your feedback on if I made any mistakes while working around in this PR & something I can improve upon to not repeat in the future.

[pmeier]

I'd be really happy to have your feedback on if I made any mistakes while working around in this PR & something I can improve upon to not repeat in the future.

The PR was good as is, but I had a few nitpicks that I did not want to bother you with. If you have a look at the commits I have sent, I just moved stuff around in the galleries and fixed a few typing issues that were not caused by you, but rather were already present in the old module. They weren't discovered earlier, because we didn't check the docs code. But now, since we have it in our regular package, it is checked.