{"id":46724714,"url":"https://github.com/iqss/docs.zeligproject.org","last_synced_at":"2026-03-09T13:01:59.536Z","repository":{"id":24171324,"uuid":"27561745","full_name":"IQSS/docs.zeligproject.org","owner":"IQSS","description":"The documentation generated from Zelig models","archived":false,"fork":false,"pushed_at":"2017-05-11T16:33:03.000Z","size":4341,"stargazers_count":5,"open_issues_count":6,"forks_count":1,"subscribers_count":17,"default_branch":"master","last_synced_at":"2024-04-16T03:47:55.127Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IQSS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-04T21:50:42.000Z","updated_at":"2024-04-16T03:47:55.127Z","dependencies_parsed_at":"2022-08-22T12:10:25.441Z","dependency_job_id":null,"html_url":"https://github.com/IQSS/docs.zeligproject.org","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/IQSS/docs.zeligproject.org","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IQSS%2Fdocs.zeligproject.org","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IQSS%2Fdocs.zeligproject.org/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IQSS%2Fdocs.zeligproject.org/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IQSS%2Fdocs.zeligproject.org/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IQSS","download_url":"https://codeload.github.com/IQSS/docs.zeligproject.org/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IQSS%2Fdocs.zeligproject.org/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30297111,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T11:12:22.024Z","status":"ssl_error","status_checked_at":"2026-03-09T11:10:54.577Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-03-09T13:01:56.987Z","updated_at":"2026-03-09T13:01:59.524Z","avatar_url":"https://github.com/IQSS.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"LEGACY docs.zeligproject.org\n=====================\n\n\u003e **Note:** this is source code for the legacy Zelig documentation website. For the most recent version see: \u003chttps://github.com/IQSS/Zelig/tree/master/vignettes\u003e.  \n\n\nThe [Zelig](http://zeligproject.org) documentation hosted at http://docs.zeligproject.org is built from the files in this repository.\n\n[Sphinx](http://sphinx-doc.org) is used to build the docs from [reStructuredText](http://en.wikipedia.org/wiki/ReStructuredText) files that are generated on-the-fly by [knitr](http://yihui.name/knitr/) which executes the Zelig code embedded in .Rrst files. \n\nWhen the docs are built periodically by [a Jenkins job](https://build.hmdc.harvard.edu:8443/job/docs.zeligproject.org/) the following versions are in use:\n\n- R 3.1.2\n- knitr 1.8\n- Python 2.7\n- Sphinx 1.2.2\n\nTo build the docs, you can install the software above on your computer or use the [Vagrant environment in another git repo](https://github.com/IQSS/zeligproject.org) to build the docs in a virtual machine.\n\n## Building the docs on your computer\n\nOnce you have the software above installed, clone this repo with...\n\n    git clone https://github.com/IQSS/docs.zeligproject.org.git\n\n... then cd to the \"doc\" directory and run `make html` or `make latexpdf`. The output will go to the \"build\" directory.\n\nIf you are satisfied with the results please feel free to make a pull request.\n\n## Building the docs in Vagrant \n\nVagrant is used to model the production server environment in which the docs are built periodically with [a Jenkins job](https://build.hmdc.harvard.edu:8443/job/docs.zeligproject.org/). By running `vagrant up`, the same scripts to build the docs in production will be used on a virtual machine running on your computer.\n\nAfter installing [Vagrant](http://vagrantup.com) and [VirtualBox](http://virtualbox.org), clone [a different repo (zeligproject.org)](https://github.com/IQSS/zeligproject.org) that contains the Vagrant environment:\n\n    git clone https://github.com/IQSS/zeligproject.org.git\n\nThen `cd zeligproject.org` (the repo you just cloned) and run `vagrant up`. After much time has passed, you should be able to see the docs at \u003chttp://localhost:8000\u003e\n\nFor more information about what Vagrant is doing, please see below.\n\n## Zelig Docs Hackers Guide to Vagrant\n\nIn Vagrant, we install R, Python 2.7 and other dependencies with this script: https://github.com/IQSS/zeligproject.org/blob/master/deploy/setup/stage1.sh\n\nThat \"stage 1\" script installs R packages such as knitr and Zelig with this script: https://github.com/IQSS/zeligproject.org/blob/master/deploy/librarysetup.r\n\nThe way to know that the \"stage 1\" script is the starting point for Vagrant is by looking at the Vagrantfile: https://github.com/IQSS/zeligproject.org/blob/master/Vagrantfile\n\nTo test building the docs in Vagrant, clone https://github.com/IQSS/zeligproject.org and `cd` into the \"zeligproject.org\" directory and run `vagrant up`.\n\n`vagrant up` will take a while as it installs R and compiles various R packages defined in the librarysetup.r script mentioned above. Now would be a good time to grab a coffee. Or lunch.\n\nWhen `vagrant up` is finished, you should see \"Docs should be visible at \u003chttp://localhost:8000\u003e\". Go ahead and click that link and see if the docs look ok.\n\nThe main script that generates the docs is https://github.com/IQSS/zeligproject.org/blob/master/deploy/post-build2 . Before executing this script in Vagrant, you must ssh into the Vagrant vm, become root, become the unprivileged \"plaid\" user, switch from Python 2.6 to 2.7, and source the script /webapps/code/zeligproject.org/deploy/workon-docs.zeliproject.org to enable virtualenvwrapper and \"workon\" the \"docs.zeligproject.org\" virtual environment. When all this is done, your prompt should look like \"(docs.zeligproject.org)[plaid@localhost ~]$\" and you should have the version of Sphinx specified in https://github.com/IQSS/zeligproject.org/blob/master/requirements.txt (1.2.2 as of this writing). You should expect to see output like this (some extra commands are executed to double-check version numbers):\n\n    murphy:zeligproject.org pdurbin$ vagrant ssh\n    Last login: Mon Dec  8 07:05:08 2014 from 10.0.2.2\n    Welcome to your Packer-built virtual machine.\n    [vagrant@localhost ~]$ sudo -i\n    [root@localhost ~]# su - plaid\n    [plaid@localhost ~]$ python --version\n    Python 2.6.6\n    [plaid@localhost ~]$ scl enable python27 bash\n    [plaid@localhost ~]$ python --version\n    Python 2.7.5\n    [plaid@localhost ~]$ sphinx-build 2\u003e\u00261 | head -1\n    Sphinx v1.1.3\n    [plaid@localhost ~]$ source /webapps/code/zeligproject.org/deploy/workon-docs.zeliproject.org\n    (docs.zeligproject.org)[plaid@localhost ~]$\n    (docs.zeligproject.org)[plaid@localhost ~]$ sphinx-build --version\n    Sphinx (sphinx-build) 1.2.2\n\nNow that you are the \"plaid\" user and have the correct version of Sphinx loaded, you can run this script to re-generate the docs and copy them into place: /webapps/code/zeligproject.org/deploy/post-build2\n\nThe output you see should be similar to the console output of the Jenkins job used to build the docs periodically: https://build.hmdc.harvard.edu:8443/job/docs.zeligproject.org/1/console\n\nAfter you have run `post-build2` your changes should be reflected at \u003chttp://localhost:8000\u003e\n\nWhen you are finished with vagrant, you may want to run `vagrant halt` or `vagrant destroy` to shut down the virtual machine or delete it, respectively.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiqss%2Fdocs.zeligproject.org","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiqss%2Fdocs.zeligproject.org","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiqss%2Fdocs.zeligproject.org/lists"}