{"id":19665577,"url":"https://github.com/fatiando/website","last_synced_at":"2025-04-28T22:31:19.578Z","repository":{"id":18853484,"uuid":"22069881","full_name":"fatiando/website","owner":"fatiando","description":"Sphinx sources used to generate the www.fatiando.org page","archived":false,"fork":false,"pushed_at":"2025-03-20T18:22:48.000Z","size":18435,"stargazers_count":5,"open_issues_count":7,"forks_count":5,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-05T11:34:12.406Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"MLH/mlh-hackathon-boilerplate","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fatiando.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"support/index.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-07-21T15:36:22.000Z","updated_at":"2025-03-20T18:22:50.000Z","dependencies_parsed_at":"2024-11-11T16:34:38.072Z","dependency_job_id":null,"html_url":"https://github.com/fatiando/website","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/fatiando%2Fwebsite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fatiando%2Fwebsite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fatiando%2Fwebsite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fatiando%2Fwebsite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fatiando","download_url":"https://codeload.github.com/fatiando/website/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251397577,"owners_count":21583034,"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-11T16:23:31.612Z","updated_at":"2025-04-28T22:31:14.538Z","avatar_url":"https://github.com/fatiando.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sphinx sources for fatiando.org\n\n[![build-html](https://github.com/fatiando/website/workflows/build-html/badge.svg?event=push)](https://github.com/fatiando/website/actions?query=workflow%3Abuild-html)\n\n## Dependencies\n\nThe website is build with [Sphinx](https://www.sphinx-doc.org/), the same tool\nwe use to generate our documentation. So if you know how to edit the docs, you\nknow how to contribute to this website as well.\n\nTo set up your development environment, create a conda environment from the\n`environment.yml` file in this repository (assuming you have some version of\nAnaconda/Miniconda/Miniforge installed):\n\n```\nconda env create\nconda activate fatiando-website\n```\n\nThe sources can be the standard reStructuredText (`.rst`) that Sphinx uses or\nMarkdown (`.md`) thanks to the [MyST](https://myst-parser.readthedocs.io)\nparser.\nWe use Markdown most of the time because it simplifies adding HTML directly to\nthe source document, which we often do for styling and fancy layouts.\n\n## Contributing\n\nRun `make serve` to generate the HTML files, serve them, and open your default\nbrowser. This command will keep serving the pages and re-building them\nautomatically any time a source file changes. You don't even have to refresh\nyour browser. To stop the server, type `Control + C`.\n\n* If you add any new pages, make sure they are included in the `toctree` entry\n  at the top of `index.md`.\n* The preferred format for sources is Markdown but RST will be acceptable if\n  you have a reason for it.\n* Navigation bar (menu) items are defined in `conf.py`.\n* The template is custom made and can be modified by editing\n  `_templates/layout.html`.\n* The main CSS stylesheet is `_static/css/style.css`.\n* We use [Bootstrap 5.1](https://getbootstrap.com/docs/5.1/getting-started/introduction/)\n  (just the CSS, not the Javascript components).\n\n### Forwarding\n\nWe use the HTML files in the `forward` folder to redirect to other domains.\nThis is not ideal but our DNS-based forwarding doesn't work with HTTPS (if you\nknow a way around this, please let us know!).\n\nThe files are copied to the output folder (`forward/dev/ -\u003e _build/html/dev`\nwhich is served as `fatiando.org/dev`).\nTo add a forward, create a new folder with an `index.html` similar to the ones\nwe already include.\n\n**Use only for long and difficult to type URLs.**\n\n## Sphinx extensions\n\nWe implement some custom sphinx extensions for adding content to our website.\nAll live under the `sphinx_extensions` folder of this repository:\n\n* `sphinx_extensions.authors`: Defines the `fatiando-authors` directive which\n  gets a list of project authors from the `AUTHORS.md` file in that project's\n  GitHub repository.\n\nAll extensions are distributed under the MIT license.\nSee [`sphinx_extensions/LICENSE.txt`](https://github.com/fatiando/website/blob/main/sphinx_extensions/LICENSE.txt).\n\n## Deployment\n\nPushing changes to [fatiando/website](https://github.com/fatiando/website)\ntriggers a build on GitHub Actions.\nThe build will check if the site compiles and also checks for broken links.\nWhen changes are pushed to the `master` branch (directly or by merging a Pull\nRequest), Actions will push the compiled site to the\n[fatiando/fatiando.github.io](https://github.com/fatiando/fatiando.github.io)\nrepository.\nGitHub serves this repository under\n[http://fatiando.github.io](http://fatiando.github.io/).\nSee `.github/workflows/build.yml`.\n\n## License\n\n[![Creative Commons License](https://i.creativecommons.org/l/by/4.0/88x31.png)](http://creativecommons.org/licenses/by/4.0/)\nThis work is licensed under a\n[Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffatiando%2Fwebsite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffatiando%2Fwebsite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffatiando%2Fwebsite/lists"}