Seeking person to create ReadtheDocs documentation skeleton

Project/team: Im an engineer who needs to set up documentation for the policy/HR team, and this project will be used and maintained by non-technical people, so documentation for how to change this documentation is really important.

Deliverable: Public Github repository that I can clone, with a README.md as to how I can set it up, run, edit files, and render local changes on my own machine. Needs to be already be deployed or have instructions on how to deploy.

Specification: something that looks like (removed by Toogit admin), with -5 top level sections and files written in RST inside the sections - Ill give you Google Docs with some docs to rewrite (doesnt need to be perfect) into the syntax.

Technologies using Sphinx build.

Some additional explanation from my colleague in case it is helpful:

Part 1: You make a bunch of raw-text files to contain all of the stuff you want on your website. You write those raw-text files using the reStructureText markup format which lets you specify things like headers, links, tables, lists, etc.

Part 2: You want to locally view the website that this corresponds to. You run a makefile which combines those raw text files with the ReadTheDocs documentation format, and that makefile run produces .html files as outputs. Those .html files are the website! You can open those files in your browser locally to see what it looks like. Granted, its not pushed to a live server, so youre not done yet.

Part 3: You make a github repo with all your raw text files, and you connect it to Read The Docs. Exciting thing: you dont ever have to rebuild your website locally. Read The Docs will set up something to detect any time you make a change to your raw text files (or anything else in the repo), and whenever a change gets made, it will run the makefile somewhere off on a server, and then it will serve the .html pages live.

Please check in with me after youve gotten the skeleton up with the file tree, and Ill give you some documents to copy paste in to make sure everything works.
About the recuiter
Member since May 20, 2018
Seroj Devi
from Aragua, Venezuela

---

---

Looking for help? Checkout our video tutorial
How to search and apply for jobs

How to apply? Do you have more questions about the Job?
See frequently asked questions