-
Notifications
You must be signed in to change notification settings - Fork 2
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
Added automated way to build documentation and deploy it to github pages #126
Conversation
This is absolutely great @fedem-p!!! There seems to be a funny duplications of titles in the left, do you know why that happens? |
I reorganized everything and now it should display correctly the different sections + the API. todo:
|
For the first part, does this work? For the second part, there is already a searchable index on the left side when checking the compiled web, and as adding the index to homepage seems to be messy it is probably in your interest to just forget about that. I like the new style of the docs, it feels very clean |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome work on the sphinx automation in docs/_templates
. Overall I don't have anything to add and the very few comments on this are just picky things on my side. After they have been addressed feel free to merge to main branch. Good work! 😃
.github/workflows/doc_deploy.yml
Outdated
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install -r requirements.txt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a need to install all requirements from the main program, to build the docs? Is just toml enough maybe? Or not even, in which case Install dependencies
job can be skipped altogether.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You were right! Thanks!
docs/intro.md
Outdated
# Sashimi | ||
|
||
<a href="url"><img | ||
src="https://github.com/portugueslab/sashimi/blob/master/sashimi/icons/main_icon.png" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This image does not seem to load correctly. Try without the hyperlink (<a></a>
) tag:
<img src=https://github.com/portugueslab/sashimi/blob/master/sashimi/icons/main_icon.png align="left" height="190" width="270">
docs/intro.md
Outdated
|
||
conda activate sashimi | ||
|
||
After this you moght have to install two extra dependencies for controlling a Cobolt laser: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technically this should read for controlling a laser through serial communication, such as Cobolt lasers.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only one minor comment, otherwise good to merge!
docs/index.md
Outdated
@@ -0,0 +1,4 @@ | |||
# Welcome to the Sashimi documentation! | |||
|
|||
maybe add index here? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be an internal comment for us, not user-visible
I've fixed the problem with the image by changing the URL, now with this, it works both on GitHub and the documentation. Regarding linking the README file directly, I couldn't find anything that worked. |
And.... Done! |
After some bugs, it can finally be triggered only by a push from the main branch.