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.

Sign up for GitHub

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

Jump to bottom

improve docs build system #219

Closed
4 of 7 tasks
grst opened this issue Dec 2, 2020 · 5 comments
Closed
4 of 7 tasks

improve docs build system #219

grst opened this issue Dec 2, 2020 · 5 comments
Labels
documentation Improvements or additions to documentation
Projects
scirpy-dev

Comments

@grst
Copy link
Collaborator

grst commented Dec 2, 2020 •
edited
Loading

Current list of stuff to solve:

  • build an overview page of available versions (see also access to v0.6.1 documentation #267)
  • move docs to separate repo to keep footprint small (?)
  • [ ] remove PR builds on merge/close (not necessary anymore, as PR docs are not uploaded to gh-pages anymore)
  • Fix version number indicated in docs sidebar
  • find a way to enable PR doc previews for forks or disable it for forks altogether (It is now disabled, and instead uploads the built docs as an artifact (add diversity metrics 07022021 #277) )
  • point the latest tag version instead of the master branch per default.
  • build tutorials in parallel
  • Can parts of this be externalized into github action modules?

Original message

The git push fails with permission denied, despite an access token being provided.
Maybe it uses the secrets from the fork instead of the main repo.
@grst grst added the documentation Improvements or additions to documentation label Dec 2, 2020
@grst grst added this to ToDo in scirpy-dev Dec 2, 2020
@grst grst moved this from ToDo to In progress in scirpy-dev Dec 2, 2020
@grst
Copy link
Collaborator Author

grst commented Dec 2, 2020

Since RTD now fully supports PR builds, it may be worth switching to that service:
https://docs.readthedocs.io/en/stable/guides/autobuild-docs-for-pull-requests.html

this also solves versioning of docs and having a separate master and stable documentation.

@grst
Copy link
Collaborator Author

grst commented Dec 2, 2020

This will serve to redirect the old docs to the new one:
https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site

and

<!DOCTYPE HTML>                                                                
<html lang="en">                                                                
    <head>                                                                      
        <meta charset="utf-8">
        <meta http-equiv="refresh" content="0;url={{THE_NEW_URL}}" />      
        <link rel="canonical" href="{{THE_NEW_URL}}" />                    
    </head>                                                                                                                                                                  
    <body>                                                                      
        <h1>                                                                    
            The page been moved to <a href="{{THE_NEW_URL}}">{{THE_NEW_URL}}</a>
        </h1>                                                                  
    </body>                                                                    
</html>

grst added a commit that referenced this issue Dec 6, 2020
@grst
Switch to RTD
c7d7ee3 
Closes #219
@grst grst mentioned this issue Dec 6, 2020
Closed
@grst
Copy link
Collaborator Author

grst commented Dec 9, 2020

After some tryouts I ran into the issue that RTD does not provide us with enough time and RAM to execute the tutorials.

I considered rtds-action to execute the notebooks on GH actions, but
it currently does not support integration with pull-requests (dfm/rtds-action#1).

Therefore, for now I will stick with github actions. It also allows parallel builds or more tutorials in the future.
I just need to figure out

  • delete old PR builds to clean up the gh-pages branch
  • point the latest tag version instead of the master branch per default.
  • find a way to enable PR doc previews for forks or disable it for forks altogether.
  • Bonus: build an overview page of available versions

@grst grst changed the title pushing to docs does not work from fork PR improve docs build system Dec 9, 2020
@grst grst moved this from In progress to future in scirpy-dev Dec 9, 2020
@grst
Copy link
Collaborator Author

grst commented May 25, 2022

scverse/cookiecutter-scverse#40 might be a better solution

@grst
Copy link
Collaborator Author

grst commented Oct 27, 2022

Superseded by #372

@grst grst closed this as completed Oct 27, 2022
scirpy-dev automation moved this from future to Done Oct 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
scirpy-dev
Archived in project
scirpy-dev
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Switch to RTD scverse/scirpy
1 participant
@grst