{"id":15475561,"url":"https://github.com/willingc/doc-basics","last_synced_at":"2026-02-18T02:35:51.411Z","repository":{"id":149801879,"uuid":"103068654","full_name":"willingc/doc-basics","owner":"willingc","description":"A minimal Sphinx documentation structure","archived":false,"fork":false,"pushed_at":"2017-09-11T00:56:42.000Z","size":13,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-01-13T14:49:50.019Z","etag":null,"topics":["conda","readthedocs","sphinx","sphinx-documentation"],"latest_commit_sha":null,"homepage":"http://doc-basics.readthedocs.io/en/latest/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/willingc.png","metadata":{"files":{"readme":"README.md","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":"2017-09-10T23:17:23.000Z","updated_at":"2017-11-06T03:51:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"f93e1077-48d8-412f-9d98-d2d6a6bb2196","html_url":"https://github.com/willingc/doc-basics","commit_stats":{"total_commits":8,"total_committers":1,"mean_commits":8.0,"dds":0.0,"last_synced_commit":"540fce1cebc442eae1feb44dcdcd5fbe746d4128"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/willingc/doc-basics","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willingc%2Fdoc-basics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willingc%2Fdoc-basics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willingc%2Fdoc-basics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willingc%2Fdoc-basics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/willingc","download_url":"https://codeload.github.com/willingc/doc-basics/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willingc%2Fdoc-basics/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29566407,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T00:47:08.760Z","status":"online","status_checked_at":"2026-02-18T02:00:09.468Z","response_time":162,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["conda","readthedocs","sphinx","sphinx-documentation"],"created_at":"2024-10-02T03:15:29.305Z","updated_at":"2026-02-18T02:35:51.387Z","avatar_url":"https://github.com/willingc.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# doc-basics\n\n[![Documentation Status](http://readthedocs.org/projects/doc-basics/badge/?version=latest)](http://doc-basics.readthedocs.io/en/latest/?badge=latest)\n\nA minimal Sphinx documentation structure.\n\nFeatures:\n\n- Python 3\n- Sphinx \u003e= 1.6\n- `docs`: the root directory for documentation\n- intersphinx using Python 3\n- supports markdown and restructured text\n- rtd yml build file\n- conda `environment.yml`\n- pip `requirements_docs.txt`\n\n## Installation\n\n1. Clone the repo from GitHub\n\n```bash\ngit clone https://github.com/willingc/doc-basics.git\n```\n\n2. Change directory to `doc-basics`.\n\n```bash\ncd doc-basics\n```\n\n3. Create and activate a virtual environment\n\n```bash\npython3 -m venv mydocenv\nsource mydocenv/bin/activate\n```\n\n4. Install requirements.\n\n```bash\npython3 -m pip install -r docs/requirements_docs.txt\n```\n\n## Build documentation\n\nFrom the `docs` directory:\n\n| Task | Command |\n| ---- | :-----: |\n| Clean out prior doc builds | `make clean` |\n| Build docs (in html format) | `make html` |\n| Check links in docs | `make linkcheck` |\n| View docs | `open _build/html/index.html` |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillingc%2Fdoc-basics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwillingc%2Fdoc-basics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillingc%2Fdoc-basics/lists"}