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

Added automated way to build documentation and deploy it to github pages #126

Merged
merged 44 commits into from
Apr 17, 2021

Conversation

fedem-p
Copy link
Member

@fedem-p fedem-p commented Feb 19, 2021

After some bugs, it can finally be triggered only by a push from the main branch.

@fedem-p fedem-p added the documentation Improvements or additions to documentation label Feb 19, 2021
@fedem-p fedem-p marked this pull request as draft February 19, 2021 10:46
@fedem-p fedem-p self-assigned this Feb 19, 2021
@fedem-p fedem-p marked this pull request as ready for review February 19, 2021 11:14
@vigji
Copy link
Member

vigji commented Feb 19, 2021

This is absolutely great @fedem-p!!!

There seems to be a funny duplications of titles in the left, do you know why that happens?

@fedem-p fedem-p marked this pull request as draft February 19, 2021 11:27
@fedem-p
Copy link
Member Author

fedem-p commented Mar 30, 2021

I reorganized everything and now it should display correctly the different sections + the API.

todo:

  • link the readme instead of copying ( I tried a bit but it seems harder than I though.. using rst to link it seems to not work with jupyter books, and I couldn't find any solution using only markdown)
  • add an index on the homepage (?)

@diegoasua
Copy link
Member

diegoasua commented Mar 30, 2021

I reorganized everything and now it should display correctly the different sections + the API.

todo:

* link the readme instead of copying ( I tried a bit but it seems harder than I though..    using rst to link it seems to not work with jupyter books, and I couldn't find any solution using only markdown)

* add an index on the homepage (?)

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

@fedem-p fedem-p closed this Mar 31, 2021
@fedem-p fedem-p reopened this Mar 31, 2021
@fedem-p fedem-p marked this pull request as ready for review March 31, 2021 09:04
Copy link
Member

@diegoasua diegoasua left a 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! 😃

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
Copy link
Member

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.

Copy link
Member Author

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"
Copy link
Member

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:
Copy link
Member

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.

Copy link
Member

@vilim vilim left a 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?
Copy link
Member

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

@fedem-p
Copy link
Member Author

fedem-p commented Apr 15, 2021

I've fixed the problem with the image by changing the URL, now with this, it works both on GitHub and the documentation.
I've also restyled the structure a tiny bit and added an index at the home page (that can be removed easily if you don't like it)

Regarding linking the README file directly, I couldn't find anything that worked.
The problem seems to be the fact that I cannot use the mainstream way to do it with an .rst because it doesn't compile properly with Jupiter books. There is some workaround to do that just with .md files, but I still need to find one that works.
In the end, I just copied pasted the content and adjusted the structure to have different sections for installation and configuration.

@diegoasua
Copy link
Member

And.... Done!

@diegoasua diegoasua merged commit 6940540 into master Apr 17, 2021
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 this pull request may close these issues.

4 participants