{"id":21984057,"url":"https://github.com/chazeon/qe-docset-autobuild","last_synced_at":"2025-03-23T01:43:32.115Z","repository":{"id":72453854,"uuid":"135674764","full_name":"chazeon/qe-docset-autobuild","owner":"chazeon","description":"Autobuild script for QE-Docset.","archived":false,"fork":false,"pushed_at":"2018-06-05T02:20:58.000Z","size":4,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-28T05:10:05.486Z","etag":null,"topics":["api-documentation","dash-docset","documentation-tool","quantum-chemistry","quantum-espresso","quantum-espresso-suite","quantum-mechanics"],"latest_commit_sha":null,"homepage":"https://chazeon.github.io/qe-docset/","language":"Python","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/chazeon.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-01T06:07:23.000Z","updated_at":"2018-06-05T02:20:59.000Z","dependencies_parsed_at":"2023-03-16T14:15:34.418Z","dependency_job_id":null,"html_url":"https://github.com/chazeon/qe-docset-autobuild","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/chazeon%2Fqe-docset-autobuild","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chazeon%2Fqe-docset-autobuild/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chazeon%2Fqe-docset-autobuild/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chazeon%2Fqe-docset-autobuild/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chazeon","download_url":"https://codeload.github.com/chazeon/qe-docset-autobuild/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245044493,"owners_count":20551898,"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":["api-documentation","dash-docset","documentation-tool","quantum-chemistry","quantum-espresso","quantum-espresso-suite","quantum-mechanics"],"created_at":"2024-11-29T18:07:17.686Z","updated_at":"2025-03-23T01:43:32.098Z","avatar_url":"https://github.com/chazeon.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QE Docset Autobuild\n\nThe script that can easily build [QE Docset](https://github.com/chazeon/qe-docset) for multiple versions of Quantum ESPRESSO under one line of command.\n\n# Usage\n\nClone the repo and the submodules, install Python submodule, and run\n```\npython3 check.py\n```\nand take a nap.\n\nThe script automatically pulls source code from Quantum ESPRESSO's official repo, and build the docsets.\n\nThen you can run\n```\npython3 build_json.py\n```\nto build the required `docset.json` file that is required for submission.\n\n# Performance\n\nI don't expect the script being executed on a daily basis so the performance is not my prior concentration. However, based on my observation, `configure`ing and compiling documentation using `pdflatex` is the most time-consuming job. I have been running this job on my ThinkPad, it is equipped with an i5-7300U CPU, and the hard-drive is NVMe SSD drive. The test is perfomed on Linux Subsystem under Windows 10.\n\nUnder this setup, each take approximately 10-13 minutes, and total 13 jobs needs to be performed as of the day this README is authored, it is about 2 hours or so to finish the entire job.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchazeon%2Fqe-docset-autobuild","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchazeon%2Fqe-docset-autobuild","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchazeon%2Fqe-docset-autobuild/lists"}