{"id":21602906,"url":"https://github.com/dials/documentation","last_synced_at":"2025-03-18T13:36:46.861Z","repository":{"id":149673203,"uuid":"177467512","full_name":"dials/documentation","owner":"dials","description":"DIALS documentation","archived":false,"fork":false,"pushed_at":"2020-02-19T22:57:55.000Z","size":14968,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-01-24T18:36:52.736Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dials.png","metadata":{"files":{"readme":"docs/README","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-24T20:47:20.000Z","updated_at":"2020-02-19T22:57:58.000Z","dependencies_parsed_at":"2023-08-31T05:30:45.687Z","dependency_job_id":null,"html_url":"https://github.com/dials/documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dials%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dials%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dials%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dials%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dials","download_url":"https://codeload.github.com/dials/documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244232384,"owners_count":20420089,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":"2024-11-24T19:14:38.824Z","updated_at":"2025-03-18T13:36:46.835Z","avatar_url":"https://github.com/dials.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"Instructions to build the DIALS documentation pages using sphinx\n================================================================\n\nPre-requisites:\n\ni)  you have the dials.github.io repository cloned in your modules directory:\n\n   $ git clone git@github.com:dials/dials.github.io.git\n\nii) you have sphinx and dependencies (docutils, etc.) installed in your\n    cctbx.python.\n\niii) Install biopython if you don’t already have it (this is to populate the\n   publications section):\n\n   $ libtbx.python -m pip install biopython\n\niv) Get the alabaster sphinx theme:\n\n   $ libtbx.python -m pip install alabaster\n\nTo update the DIALS webpages:\n\n1) Update the dials.github.io:\n\n  $ git pull --rebase\n\n2) Make changes to the .rst files in dials/doc/sphinx. Commit the resulting\n   changes to the .rst files to the dials repository (ideally after running\n   steps 3 \u0026 4 to visually inspect the generated html files).\n\n3) Build the documentation using the dev.dials.make_sphinx_html command which\n   builds the sphinx documentation and copies the output into the\n   dials.github.io.git directory.\n\n   $ dev.dials.make_sphinx_html\n\n4) View the documentation! e.g. on mac:\n\n   $ open $(libtbx.find_in_repositories dials.github.io)/index.html\n\n5) Either (i) commit the resulting changes to the dials.github.io repository to\n   make modifications immediately available or (ii) wait for the next Jenkins\n   job to re-build the website (this happens nightly UK time). If you choose not\n   to commit your local changes, you might want to run the following git\n   commands (in the dials.github.io source directory) which reset the local\n   changes to the dials.github.io repository and remove untracked\n   files/directories, before running any future git pull commands:\n\n   $ git checkout . ; git clean -f -d\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdials%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdials%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdials%2Fdocumentation/lists"}