Skip to content
This repository has been archived by the owner on May 16, 2024. It is now read-only.

[NEW] Build and deploy github sphinx project page #395

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[NEW] Build and deploy github sphinx project page #395

wants to merge 1 commit into from

Conversation

mileo
Copy link
Member

@mileo mileo commented Dec 5, 2016 •
edited
Loading

Hi,

With this feature we can automatic deploy module doc to a sphinx github page:

  • autodoc will create module docs automaticaly from docstring;
  • when merged to destination branch, the new version of the documentation is pushed to the branch gh-pages;

Job Example: https://travis-ci.org/kmee/l10n-brazil/jobs/181258185
Website example: http://www.odoobrasil.org.br/
Autodoc example: http://www.odoobrasil.org.br/py-modindex.html

Future roadmap:

@mileo mileo changed the title [NEW] Build and deploy github sphinix project page [WIP][NEW] Build and deploy github sphinix project page Dec 5, 2016
lasley
lasley approved these changes Dec 6, 2016
View reviewed changes
Copy link
Contributor

@lasley lasley left a comment

Choose a reason for hiding this comment

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

Awesome thanks @mileo - few comments, non-blocking

travis/travis_after_tests_success Outdated
@@ -19,3 +22,12 @@ if (os.environ.get('TESTS', '1') == '1' and
codecov_main(argv=None)
except:
pass

if os.environ.get('DOC') == '1':
Copy link
Contributor

Choose a reason for hiding this comment

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

Not a blocker, but can we name this AUTODOC instead? It'll jive a little better with pre-existing jargon IMO.

travis/travis_after_tests_success Outdated
'deploy'
])

sys.exit(0 if status == 0 else 1)
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not just directly exit using the subprocess.call status code?

@mileo mileo force-pushed the feature/sphinix-github-pages branch from dbdb7c8 to 3d22e8f Compare January 6, 2017 03:31
@mileo
Copy link
Member Author

mileo commented Jan 6, 2017

@lasley FIXED, please tag as need review.

@lasley
Copy link
Contributor

lasley commented Jan 6, 2017 •
edited
Loading

@mileo I'm not a PSC of this repo, @OCA/community-maintainers @moylop260 @pedrobaeza - mind adding the WIP tag please?

@mileo mileo changed the title [WIP][NEW] Build and deploy github sphinix project page [WIP][NEW] Build and deploy github sphinx project page Jan 6, 2017
leorochael
leorochael reviewed Jan 6, 2017
View reviewed changes
travis/travis_install_nightly Outdated
pip install --upgrade docutils
pip install --upgrade pillow
pip install --upgrade --user travis-sphinx
export PATH=$HOME/.local/bin:$PATH
Copy link

Choose a reason for hiding this comment

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

I suggest placing the name of all packages above into a file requirements-travis-sphinx.txt and calling pip install --upgrade -r requirements-travis-sphinx.txt.

I don't think installing travis-sphinx with --user is necessary.

leorochael
leorochael approved these changes Jan 6, 2017
View reviewed changes
Copy link

@leorochael leorochael left a comment

Choose a reason for hiding this comment

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

Other than that small comment, I'm ok with this PR

@mileo mileo changed the title [WIP][NEW] Build and deploy github sphinx project page [NEW] Build and deploy github sphinx project page Jan 6, 2017
@mileo mileo force-pushed the feature/sphinix-github-pages branch from 3d22e8f to 2506350 Compare January 6, 2017 19:25
@mileo
Copy link
Member Author

mileo commented Jan 6, 2017

@max3903 Can you review this PR. If approved i can work in integration with robotframework.

Thanks in advance

@moylop260 moylop260 added WIP and removed needs review labels Jan 9, 2017
@moylop260
Copy link
Contributor

Could you add a AUTODOC="1" build from .travis.yml?

@mileo mileo force-pushed the feature/sphinix-github-pages branch 3 times, most recently from 51427dc to 907155e Compare January 9, 2017 18:33
blaggacao
blaggacao reviewed Jan 9, 2017
View reviewed changes
tests/test_repo/docs/source/conf.py Outdated
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'pt_BR'
Copy link

Choose a reason for hiding this comment

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

Really a good default for an international repo?

blaggacao
blaggacao reviewed Jan 9, 2017
View reviewed changes
Copy link

@blaggacao blaggacao left a comment

Choose a reason for hiding this comment

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

Just a question, if those hard coded references to brazilian localisation are desired?

tests/test_repo/docs/source/conf.py Outdated


# List of addons name to load (if empty, no addon will be loaded)
sphinxodoo_addons = ['l10n_br_base']
Copy link

Choose a reason for hiding this comment

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

good default?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, already removed. Thanks

@blaggacao
Copy link

@mileo I could not see on a quick look how

"when merged to destination branch, the new version of the documentation is pushed to the branch gh-pages;"

is achieved. It would be great, would it not be absolutely github specific, there are people who use bitbucket or increasingly gitlab. Being able to make the final location configurable under this aspect would be a very much appreciated consideration.

@mileo mileo force-pushed the feature/sphinix-github-pages branch 3 times, most recently from 785cade to fa58262 Compare January 10, 2017 00:22
@mileo mileo changed the title [NEW] Build and deploy github sphinx project page [WIP][NEW] Build and deploy github sphinx project page Jan 10, 2017
@lasley
Copy link
Contributor

lasley commented Jan 26, 2017 •
edited
Loading

@mileo - Is this still WIP? I tested this build and it seems to work fine, so IMO we should move forward with the few test fixes, review + merge on this version & scope additional features to other PRs.

@mileo mileo force-pushed the feature/sphinix-github-pages branch from fa58262 to 62468c2 Compare January 27, 2017 00:57
@mileo
Copy link
Member Author

mileo commented Jan 27, 2017

@lasley i pushed some fixes from @vonpupp. Yes, Now we can move foward! =D

@lasley
Copy link
Contributor

lasley commented Jan 27, 2017

Sweet, any idea on the build errors? Also, maybe remove WIP from the title?

@mileo mileo changed the title [WIP][NEW] Build and deploy github sphinx project page [NEW] Build and deploy github sphinx project page Jan 27, 2017
@mileo mileo force-pushed the feature/sphinix-github-pages branch from 0f08877 to c99efc6 Compare February 15, 2017 19:44
@mileo
Copy link
Member Author

mileo commented Feb 15, 2017

@moylop260 @lasley @leorochael @blaggacao

I tried to make the tests happen several times ... I could not understand the problem

Master branch isn't green in our travis: https://travis-ci.org/kmee/maintainer-quality-tools/builds/202065922

Thanks for any help

@moylop260
Copy link
Contributor

flake8 changed the name of a check more info:
ea94205

NOTE: We need improvement the output of the tests

@mileo mileo force-pushed the feature/sphinix-github-pages branch from f280a0a to 259f38a Compare February 17, 2020 21:43
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@blaggacao blaggacao blaggacao left review comments

@lasley lasley lasley approved these changes

@leorochael leorochael leorochael approved these changes

Assignees
No one assigned
Labels
WIP
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@mileo @lasley @moylop260 @blaggacao @leorochael @dreispt