{"id":21649400,"url":"https://github.com/sadielbartholomew/sphinx-from-scratch","last_synced_at":"2025-10-09T19:43:46.784Z","repository":{"id":107666258,"uuid":"309459716","full_name":"sadielbartholomew/sphinx-from-scratch","owner":"sadielbartholomew","description":"Source and notes for a SORSE software demo (10.5281/zenodo.3977886)","archived":false,"fork":false,"pushed_at":"2020-11-13T14:44:27.000Z","size":6269,"stargazers_count":6,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T15:49:08.734Z","etag":null,"topics":["auto-generator","configuration","customisation","demo","documentation","rse","sphinx","sphinx-doc"],"latest_commit_sha":null,"homepage":"https://zenodo.org/record/3977886#.X6BP7nX7TeQ","language":"Python","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/sadielbartholomew.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":"2020-11-02T18:27:23.000Z","updated_at":"2024-07-25T13:28:30.000Z","dependencies_parsed_at":null,"dependency_job_id":"9594e289-21a1-4fc1-8311-3413d05cd4b3","html_url":"https://github.com/sadielbartholomew/sphinx-from-scratch","commit_stats":{"total_commits":11,"total_committers":1,"mean_commits":11.0,"dds":0.0,"last_synced_commit":"4f6bef8b0561cd86c8ef3adea3b25ef66b1e11f4"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sadielbartholomew%2Fsphinx-from-scratch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sadielbartholomew%2Fsphinx-from-scratch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sadielbartholomew%2Fsphinx-from-scratch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sadielbartholomew%2Fsphinx-from-scratch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sadielbartholomew","download_url":"https://codeload.github.com/sadielbartholomew/sphinx-from-scratch/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248468525,"owners_count":21108835,"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":["auto-generator","configuration","customisation","demo","documentation","rse","sphinx","sphinx-doc"],"created_at":"2024-11-25T07:26:38.535Z","updated_at":"2025-10-09T19:43:46.677Z","avatar_url":"https://github.com/sadielbartholomew.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sphinx-from-scratch\n\nSource and notes for a SORSE software demo 10.5281/zenodo.3977886\n\nSee: https://zenodo.org/record/3977886#.X6nx43X7TeR\n\n\n## About\n\n\n### Background and guide to building from scratch\n\nThe directory `converting-txt-or-md-to-rst/` provides files each covering the:\n\n* context i.e. background information for the demonstration\n  (``context.\u003cextension\u003e``); and the\n* list of steps for how to generate the documentation for the dummy project\n  from scratch, as roughly followed in the demonstration itself\n  (``steps-to-recreate.\u003cextension\u003e``),\n\nin both the markdown (`.md`, which is very similar to plain text, often `.txt`)\nand reStructuredText (`.rst`, RST for short) file formats, to serve as\nexamples of RST which is used as the markup language for the documentation\nsource files by Sphinx.\n\n\n### Pre-made directory of the built documentation\n\nA pre-built example of the generated documentation, including the source,\nis provided under the `docs` directory. You can view the outputs as follows:\n\n* the **built HTML** can be viewed after opening up the HTML index page in a\n  browser, for example:\n\n  ```console\n  $ firefox docs/build/html/index.html\n  ```\n\n* and the **built LaTeX** form can be viewed either:\n\n  * as the raw LaTeX source via opening `docs/build/latex/quadrilaterals.tex`\n    in a text or TeX editor, for example (with\n    [`texmaker`](https://www.xm1math.net/texmaker/) installed):\n\n    ```console\n    $ texmaker docs/build/latex/quadrilaterals.tex\n    ```\n  * or as a PDF by opening up the built PDF,\n  `docs/build/latex/quadrilaterals.pdf`, for example via\n  (with [`evince`](https://wiki.gnome.org/Apps/Evince) installed):\n\n    ```console\n    $ evince docs/build/latex/quadrilaterals.pdf\n    ```\n\nNote that the pre-built documentation can be amended and re-built using some\nof the commands provided and explained in the\n``converting-txt-or-md-to-rst/steps-to-recreate.\u003cextension\u003e`` file.\n\n\n## Questions\n\nPlease feel free to email *sadie.bartholomew@ncas.ac.uk* if you have any\nquestions about the topics of the software demonstration or this repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsadielbartholomew%2Fsphinx-from-scratch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsadielbartholomew%2Fsphinx-from-scratch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsadielbartholomew%2Fsphinx-from-scratch/lists"}