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

Perform some search engine optimization for docs #309

Closed
marscher opened this issue Mar 29, 2021 · 9 comments · Fixed by #312
Closed

Perform some search engine optimization for docs #309

marscher opened this issue Mar 29, 2021 · 9 comments · Fixed by #312
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@marscher
Copy link
Collaborator

Currently the documentation is hard to find on engines like google, duckgosearch, bing etc.
One has to enforce the inclusion of the term "weldx" by using quotation marks. Eventually we should somehow highlight this more.

@marscher marscher added the documentation Improvements or additions to documentation label Mar 29, 2021
@marscher marscher self-assigned this Mar 29, 2021
@marscher
Copy link
Collaborator Author

cref #307

@marscher
Copy link
Collaborator Author

It seems the version number is currently not avail on RTD although the package gets installed.

@CagtayFabry
Copy link
Member

good catch, I wonder why this happens..

It seems the version number is currently not avail on RTD although the package gets installed.

@CagtayFabry
Copy link
Member

CagtayFabry commented Mar 29, 2021

I think one way would be to just include setuptools_scm in the docs requirement and directly run

from setuptools_scm import get_version
version = get_version(root='..', relative_to=__file__)

in conf.py

@marscher
Copy link
Collaborator Author

This is a good solution. Thanks!

@marscher
Copy link
Collaborator Author

Hold on, do we have setuptools_scm installed on RTD?

@marscher
Copy link
Collaborator Author

I think it arises from having weldx always imported from the sources root (where the version is undefined; it only gets defined during pip install).

@CagtayFabry
Copy link
Member

I think it arises from having weldx always imported from the sources root (where the version is undefined; it only gets defined during pip install).

Ah yes that might be it. Probably because RTD doesn't pip install -e ., otherwise the version.py file would be created in the source install
see readthedocs/readthedocs.org#4960

How about

try:
    import weldx
except ModuleNotFoundError: # fallback for local use
    sys.path.insert(0, os.path.abspath("../"))
    import weldx
except Exception as ex:
    raise

@CagtayFabry
Copy link
Member

looking good #310

@marscher marscher mentioned this issue Mar 29, 2021
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants