Skip to content

[python + travisCI] Automatically deploy and generate documentation #58

Open
Open
[python + travisCI] Automatically deploy and generate documentation#58
Assignees
edeediong
Labels
hacktoberfestcontributors incredibly welcome!

Description

@yochannah
yochannah
opened on Oct 22, 2019

HTML documentation for our library can be generated using the pydoc -w command.

It would be nice to use travis or github actions to automatically generate docs and deploy them to the gh-pages branch of this repo.

This should only happen for the master branch.

if you want to pick up this task

  1. Take a look at the InterMine contributing guidelines
  2. Comment on this issue stating that you intend to work on the task
  3. When you're ready, add your work to the repo and create a pull request.

What to do if you need help

Mention @yochannah, tweet @yoyehudi, pop by to say hi on chat or if needed email [email protected]. Don't forget we're usually only available during uk office hours and will not be able to respond at other times :)

Activity

  1. yochannah
    added
    hacktoberfestcontributors incredibly welcome!
    on Oct 22, 2019

  2. biswajitpatra commented on Oct 22, 2019

    @biswajitpatra
    biswajitpatra
    on Oct 22, 2019

    can i take this up?

  3. yochannah commented on Oct 22, 2019

    @yochannah
    yochannah
    on Oct 22, 2019
    MemberAuthor

    @biswajitpatra Go for it! 🚀

  4. yochannah
    assigned
    biswajitpatra
    on Oct 22, 2019

  5. yochannah commented on Dec 9, 2019

    @yochannah
    yochannah
    on Dec 9, 2019
    MemberAuthor

    Hey @biswajitpatra - did you ever get the chance to look at this? :)

  6. yochannah
    unassigned
    biswajitpatra
    on Dec 24, 2019

  7. anmol27katyani commented on Jan 16, 2020

    @anmol27katyani
    anmol27katyani
    on Jan 16, 2020

    Hello @yochannah , I just saw this issue and I looked up for how I can approach, and I found https://circleci.com/blog/deploying-documentation-to-github-pages-with-continuous-integration/
    I will be taking help from the mentioned webpage to see how it is done. I know this is for Circleci and Intermine is using Travis at the moment, I would like to take this up and fix this.

  8. yochannah commented on Jan 22, 2020

    @yochannah
    yochannah
    on Jan 22, 2020
    MemberAuthor

    Hey @anmol27katyani ! That sounds fine, but one question- is Circle free for open source projects?

  9. edeediong commented on Mar 8, 2020

    @edeediong
    edeediong
    on Mar 8, 2020

    @yochannah I'd love to pick up this issue.

    Observations

    1. I have a few questions from my observations. I noticed running a pydoc -w intermine just creates the intermine.html file for the folder. If you click any of the hyperlinks it throws an error because the pydoc didn't create HTML for each of the Python files in the folder. Shouldn't it run create HTML files for everything or am I running the command wrongly?
    2. To auto-generate docs, when should the travis build run? Is it on every PR or Merge or when there's an update to the codebase? I'm still trying to wrap my head around when it should be run.

  10. yochannah commented on Mar 13, 2020

    @yochannah
    yochannah
    on Mar 13, 2020
    MemberAuthor

    @edeediong please go ahead!

    1. Check out the readme - we have a slightly different command, pydoc intermine.query.Query that does what we need.
    2. For travis - I think if you set up scripting so it can run the build every time, every PR/merge would be perfect. every change to master I think.
  11. yochannah
    assigned
    edeediong
    on Mar 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

hacktoberfestcontributors incredibly welcome!

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions