question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Move online documentation to Github Pages

See original GitHub issue

The old PyPI doesn’t allow to upload new documentation to pythonhosted.org, so we need to remove the docs hosted there and move them to readthedocs.

CAM-Gerlach Edit:

  • Move docs from both repo branches
  • Create/add other key files
    • README
    • CONTRIBUTING
    • LICENSE
    • AUTHORS
    • .gitignore
    • .gitattributes
  • Minor fixes to existing docs
    • Harmonize line endings to LF
    • Remove extra spaces
    • Fix build warnings
  • Add sphinx building and enable Travis
    • Add/Setup sphinx makefiles
    • Create/setup .travis.yml
    • Enable Travis and test builds
  • Setup repo settings
    • Permissions
    • Tags
    • Description
    • Protected branches
    • Other settings as needed
  • Setup and enable doctr deployment
    • Create gh-pages and .nojekyll
    • Configure doctr settings and keys
    • Add doctr deployment to Travis
    • Test functionality and deploy
  • Other work items
    • Update conf.py with modernization and fixes
    • Minor doc updates
  • Before initial public release
    • Update out of date screenshots
    • Baseline editing pass to update and copyedit
      • Initial cross-file changes
      • Per-file updates, copyediting, line breaks and minimal expansion
      • Apply remaining cross-file style guide formatting and fix links
    • Decide on modern theme
    • Add Profiler doc: PR REVIEW
  • Final steps to release
    • Decide on what to do about multiple branches and implement
    • Redirect to docs.spyder-ide.org subdomain
    • Add banner and fonts, etc. from our main website
    • Final layout and link fixes
    • Font size harmonization
    • Add common footer (?)
    • Update other links throughout Spyder to point to new docs instead of PyHosted: PR REVIEW
    • Make layout adaptive/non-broken on narrower screens/windows
  • Following release
    • Inform/submit PRs to other sources to add/update Spyder website and doc links
    • Redirect or eventually remove PyHosted docs (in a few months)

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:30 (30 by maintainers)

github_iconTop GitHub Comments

1reaction
ccordoba12commented, Mar 11, 2018

Let’s try with Github pages first.

0reactions
CAM-Gerlachcommented, Mar 31, 2018

It should be ready by the end of next week, but I’d like to have a new theme in place for our docs before doing the transition.

That’s quite a while, but I suppose it makes sense if it takes us that long to decide on a theme. Hopefully I’ll have the baseline editing pass and the screenshots done sooner, as well.

That would be a great start!

I can’t promise how much in-depth content work I can prioritize for 3.2.9 considering my many other tasks for that and other near-term milestones (website, funding, etc), but hopefully @jitseniesen can pitch in there at some point.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Redirecting GitHub pages after a repository move
GitHub will helpfully redirect all of your repository stuff hosted on github.com after the move, but will not redirect the GitHub Pages hosted...
Read more >
Deploying to GitHub Pages - Codecademy
Deploying to GitHub Pages ... Share your website with the world, for free! ... GitHub is a great tool to store projects and...
Read more >
How to Upload Your Startup Website to GitHub Pages
On the upload page, you can drag-and-drop files and folders and they will be added to the repo. Go to the root directory...
Read more >
Getting Started with GitHub Pages - YouTube
Hey gang, in this tutorial I'll show you how to get up and running with GitHub pages to host your projects on the...
Read more >
How to create a documentation site with Docsify and GitHub ...
By default, GitHub Pages prompts users to use Jekyll, a static site generator that supports HTML, CSS, and other web technologies ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found