Commit Graph

6 Commits

Author SHA1 Message Date
Julian 9c8528df2e
Update Contribution Guidelines, add `FAQ`, `CONTACT` and `CONTRIBUTING` as separate documents, fix links (#8448)
* Add FAQ as separate document. Removed from RST docs.

Future work:

* Add references to contact us.

* Substantial Rewrite of Contributing Guidelines

* Updated with review comments.

* Avoid duplicating contribution instructions

Reference the contribution guidelines online rather than repeating them.
Make language more consistent with other sources.

* Reshuffle contents based on review comments.

* Move contributing to root dir, populate it with contents of contribute.rst and contribute-unittest.rst
* Delete contribute.rst and contribute-unittest.rst
* Delete the defunct Google Summers of Code
*Add CONTACT.md, populating it from CONTACT.rst.
* Reference new CONTACT.md from Index.
* Fix broken links, ToC.
* Fix another link.
* Bring in changes to README and setup.py from #8450.
* Include OpenGL reference
* Mention all the sponsors.

* Wrong README file was modified - try again

* Updated a bunch of http -> https

Not every single instance, but made a major dent.
Only instances where https worked (inclem.net, I am looking at you.)

* Update CODE_OF_CONDUCT.md to be the most modern version

* Update with review comments

* Correct link

* Add stubs for GitHub-hosted pages

* Fix links

RST broken by line feed.
Inline link.
2023-11-23 18:31:19 +01:00
Paul Cochrane ce0bf8c7dc
Purge trailing whitespace in docs source files (#7930)
Trailing whitespace is forbidden in source code for this project
(implemented as part of the PEP8 checks), however the documentation
source files contained trailing whitespace.  It seemed appropriate to
remove trailing whitespace in the documentation source files as well.
2022-10-02 20:47:05 +02:00
Tony Narlock d300168621 Improve and refactor doc readme
- Fix indentation / code blocks. Tabs to spaces. Refactor sections.
- Improvements for dual reST+markdown compatibility
2017-04-22 14:25:39 -05:00
John Mercouris 3c0c8d759c Updated readme to show easier ways to install sphinx on OSX or other systems with pip enabled 2016-06-23 21:19:39 +02:00
dessant 3b9add262c Update README.md 2015-10-05 19:54:29 +03:00
dessant f859c66076 Rename README to README.md 2015-10-05 19:47:13 +03:00