Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Revamp standard docs, remove README contribution notes #87

Closed
wants to merge 16 commits into from

Conversation

pacrob
Copy link
Contributor

@pacrob pacrob commented Apr 25, 2023

What was wrong?

Documentation across snakecharmer libraries is very varied.

Some good examples:

  • I like the sections in py-evm and web3: Introduction, Quickstart, Community, and Code of Conduct
  • eth-abi at least has a Welcome page

Most of the others are relatively light, if not just auto-generated or nothing at all.

This PR will collect removing stuff from the README and moving things into standardized sections of docs.

note for later - .rst code blocks can have copyable set to make it easier to copypasta for users

.. code-block:: python
   :copyable:

   def my_function():
       print("Hello, World!")

Closes #78

Cute Animal Picture

image

pacrob and others added 14 commits April 3, 2023 14:36
bump docs dependencies, add readthedocs requirements
* convert bash scripts to py
* bump versions in dependencies and ci builds

* move tox to [dev] per issue ethereum#34

* move RTD deps pointer into .readthedocs.yml

* unpin flake8 add flake8-bugbear to lint deps
* remove gitter, testing setup, and pandoc sections, add quotes to dev install
* repin flake8, bump tox to >=4.0.0 as that's where whitelist was deprecated, misc updates
* template cleanup following initial merge with py-evm

* add flake8 pin comment

* correct license years

* add pin note to mypy
…m#81)

* apply template updates found following merge with eth-typing

* add build as a dev dependency

* remove timeout from pytest.ini, it doesn't do anything without pytest-timeout as a dep
* add updates found when merging template with py-ssz and eth-abi

* add wheel and wheel-windows to ci and reorg
@pacrob pacrob force-pushed the move-readme-dev-info-to-docs branch 4 times, most recently from 274b304 to 2df66bc Compare April 25, 2023 23:01
@pacrob pacrob force-pushed the move-readme-dev-info-to-docs branch 6 times, most recently from dfe9148 to b1fd0de Compare April 27, 2023 14:44
@pacrob pacrob force-pushed the move-readme-dev-info-to-docs branch from b1fd0de to 2cccf7f Compare April 27, 2023 17:16
@pacrob pacrob changed the title remove README contribution notes, add bits to contributing docs [WIP] Revamp standard docs, remove README contribution notes Apr 27, 2023
@kclowes
Copy link
Contributor

kclowes commented May 3, 2023

As you're thinking about standardizing contributing docs, I was thinking it might be good to document the make lint-roll command in the contributor docs if you haven't already. Then maybe contributors don't need to fight as much with the linter.

@pacrob
Copy link
Contributor Author

pacrob commented May 24, 2023

Many libs actually don't have docs, so also have a pattern with contribution info still in the README

@pacrob
Copy link
Contributor Author

pacrob commented May 21, 2024

closed by #134

@pacrob pacrob closed this Oct 22, 2024
@pacrob pacrob deleted the move-readme-dev-info-to-docs branch October 24, 2024 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Build out default docs
3 participants