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

Migrate documentations #5

Open
yukiisbored opened this issue May 5, 2017 · 4 comments
Open

Migrate documentations #5

yukiisbored opened this issue May 5, 2017 · 4 comments
Assignees

Comments

@yukiisbored
Copy link
Member

Due to a couple of problems regarding aggregating documentations. I'm planning to build the docs in this repository via Travis instead of aggregating pre-compiled HTML pages. This will ensure that every documents are working correctly and are handled by a single instance of sphinx.

It'll be based of 3 components:

  • A script that pushes the raw reStructuredText/Markdown files to the master branch of this repository.
  • A script that combines index files into a single index.rst. Obviously this has to be written in rST.
  • A CI setup in this repository that compiles the documents with Sphinx into a accessible website.
@yukiisbored yukiisbored self-assigned this May 5, 2017
@yukiisbored
Copy link
Member Author

TODO List:

  • A new basic Sphinx setup
  • Index compiler
  • Documents pusher script
  • CI setup to build pages.
  • Create documentations on how to integrate to this system

@yukiisbored
Copy link
Member Author

yukiisbored commented May 5, 2017

A brief on how it'll work:

  • Documents and the index are stored on the project repositories itself. Sphinx/Jekyll aren't required, just the raw Markdown/rST files.
  • Documents are pushed to this repository via a script that's triggered from the project's CI.
  • Since the documents are pushed via git, It'll trigger this repository's CI
  • This repository's CI will build the HTML page with Sphinx and compile the index files.
  • This repository's CI will push it to the gh-pages branch.
  • and an easy to browse website can be used to read the documentations.

@pri22296
Copy link
Member

pri22296 commented May 6, 2017

@yukiisbored for this to work, contents of the docs directory of project repositories would need to be in a different branch. wouldn't it? Or would the rst/md files be pushed to this repo?

@pri22296
Copy link
Member

pri22296 commented May 7, 2017

@yukiisbored If you havent't started on the index combining script, I'd like to work on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants