Lightsteem documentation is up!

in #lightsteem6 years ago (edited)

Screen Shot 2018-08-16 at 3.30.02 PM.png

I have been working on the design of lightsteem in the latest couple of weeks and I feel like the library is in a good state, so I have created a documentation for potential developers want to try the library.

It's online at https://lightsteem.readthedocs.io


Documentation Pages


I have used Sphinx and rtfd.org to write and host the documentation. All documentation files are stored at the /docs folder inside .RST formatted files.

Let me know you if you're interested in the library and feel like there are missing concepts.

Screen Shot 2018-08-16 at 3.47.43 PM.png

Contributing to the documentation


  • Fork the repository
  • Create a new branch. Eg: (typo-fix)
  • Install sphinx sphinx-autobuild packages on your virtual environment.
  • Run sphinx-autobuild docs docs/_build/html --port=8001. This command will serve the documentation on http://localhost:8001.
  • Make changes you want on .RST files.
  • Create a pull request

Related commits


Sort:  
Loading...

Interesting post my friend, invite visit my post https://steemit.com/steempress/@jadnven/an-old-wanderer-photo-tales ..... follow you

Hi @emrebeyler! We are @steem-ua, a new Steem dApp, computing UserAuthority for all accounts on Steem. We are currently in test modus upvoting quality Utopian-io contributions! Nice work!

Hey @emrebeyler
Thanks for contributing on Utopian.
Congratulations! Your contribution was Staff Picked to receive a maximum vote for the documentation category on Utopian for being of significant value to the project and the open source community.

We’re already looking forward to your next contribution!

Want to chat? Join us on Discord https://discord.gg/h52nFrV.

Vote for Utopian Witness!

Coin Marketplace

STEEM 0.19
TRX 0.15
JST 0.029
BTC 62980.29
ETH 2631.01
USDT 1.00
SBD 2.82