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

Switch from GitHub Pages to Read the Docs #51

Merged
merged 2 commits into from
Apr 5, 2018

Conversation

TagnumElite
Copy link
Member

@TagnumElite TagnumElite commented Feb 4, 2018

@niftools/pyffi-reviewer

Overview

Stops deploying documentation to GitHub pages

Additional Information

  • Read the Docs documentation

  • Create accout

  • Connect account

  • Import Project

  • Setup Project

    • Settings:
      • Description: PyFFI is a Python library for processing block structured files.
      • Programming Language: Python
      • Tags: niftools, pyffi, fileformat, nif, cgf, binary, interface, stripify
    • Advanced Settings:
      • Install Project: ✅
      • Requirements file: ./requirements-dev.txt
      • Default Version: develop
      • Python interpreter: CPython 3.x
    • Versions:
      • develop: ✅
      • master: ✅
    • Domains: Two things can happen here. You have have an url like http://pyffi.niftools.org or http://docs.niftools.org/project/pyffi/
    • Maintainers: Remember to set maintainers
    • Integrations: Make sure a GitHub incoming webhook is setup properly!

Big checklist but it all I could come up with to make sure you understood everything.

Reasons why:

  1. You don't want to give Travis GitHub access tokens.
  2. Internationalisation
  3. Multiple versions.

Also, I add logos to Build Badges
I will be doing this for blender_nif_plugin as well.

…on't need to give travis user access and far better multiversion and multi-languange support.
@coveralls
Copy link

coveralls commented Feb 4, 2018

Coverage Status

Coverage remained the same at 58.38% when pulling 5e9a80f on TagnumElite:rtfd into 6cd6f6c on niftools:develop.

@neomonkeus
Copy link
Member

Should we not continue to do both?

@TagnumElite
Copy link
Member Author

I don't see the reason to keep it, it will be the exact same as RTD versions. I can let Travis still build the docs to check for errors but there is no need for Travis to publish docs on GitHub pages.

@neomonkeus
Copy link
Member

Niftools.org uses github pages for project documentation site.

@TagnumElite
Copy link
Member Author

I know, but you could make /pyffi/ redirect to pyffi.niftools.org if you set the subdomain to the RTD project other wise if you want to keep it just follow the steps and close this pull request without merging it and it will work fine.

@neomonkeus neomonkeus merged commit 0f37450 into niftools:develop Apr 5, 2018
@neomonkeus neomonkeus moved this from In Review to Done in Pyffi Release Readiness Apr 5, 2018
@TagnumElite TagnumElite deleted the rtfd branch April 27, 2018 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

3 participants