mirrors/LibCST
1
0
Fork 0
mirror of https://github.com/Instagram/LibCST.git synced 2025-12-23 10:35:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Link to ReadTheDocs from our README file

Browse source 
This should make it possible for people to find our more detailed
documentation.
This commit is contained in:
Benjamin Woodruff 2019-08-07 14:56:51 -07:00 • committed by Benjamin Woodruff
parent bf94bad977
commit dd22dd0361
1 changed files with 16 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.rst
View file

@ -4,7 +4,13 @@
A Concrete Syntax Tree (CST) parser and serializer library for Python
.. image:: https://circleci.com/gh/Instagram/LibCST/tree/master.svg?style=svg&circle-token=f89ff46c689cf53116308db295a492d687bf5732
|readthedocs-badge| |circleci-badge|
.. |readthedocs-badge| image:: https://readthedocs.org/projects/pip/badge/?version=latest&style=flat
:target: https://libcst.readthedocs.io/en/latest/
:alt: Documentation
.. |circleci-badge| image:: https://circleci.com/gh/Instagram/LibCST/tree/master.svg?style=shield&circle-token=f89ff46c689cf53116308db295a492d687bf5732
:target: https://circleci.com/gh/Instagram/LibCST/tree/master
:alt: CircleCI
@ -24,6 +30,12 @@ fields, we've created a lossless CST that looks and feels like an AST.
.. why-libcst-intro-end
You can learn more about `the value that LibCST provides
<https://libcst.readthedocs.io/en/latest/why_libcst.html>`__ and `our
motivations for the project
<https://libcst.readthedocs.io/en/latest/motivation.html>`__
in `our documentation <https://libcst.readthedocs.io/en/latest/index.html>`__.
::
1 + 2
@ -87,6 +99,9 @@ BinaryOperation(
],
)
For a more detailed usage example, `see our documentation
<https://libcst.readthedocs.io/en/latest/usage.html>`__.
Installation
------------