Skip to content

GH action to build and deploy docs V2#92

Closed
cadenmyers13 wants to merge 4 commits into
diffpy:mainfrom
cadenmyers13:main
Closed

GH action to build and deploy docs V2#92
cadenmyers13 wants to merge 4 commits into
diffpy:mainfrom
cadenmyers13:main

Conversation

@cadenmyers13

Copy link
Copy Markdown
Contributor

closes #52

Used code from docs.yml in diffpy.utils.

Comment thread doc/manual/source/conf.py
@@ -13,7 +13,7 @@
import sys
import os
sys.path.insert(0, os.path.abspath('../..'))

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

does this need to be changed to .abspath('../../..') ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In general we are moving from sys.path to pathlib, so whenever we touch code and have the opportunity to do that, let's do that. I can't answer you question without some effort, but if you can try and make sure all the docs build correctly and all the links work, you can probably figure it out.

Summary:
yes, everywhere you can, replace sys.path with pathlib.Path syntax and (b) build the docs and make sure the links all work.

@sbillinge

Copy link
Copy Markdown
Contributor

replaced by #93

@sbillinge sbillinge closed this May 21, 2024
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.

make GH action that publishes documentation automatically on release

2 participants