Commit graph

20 commits

Author SHA1 Message Date
Zsolt Dollenstein
42df0881ba
Fix doc build error (#1221)
Apparently doc2path now returns a path not a string
2024-10-10 11:20:25 +01:00
MapleCCC
79cf251896
Update Sphinx to 5.1.1 (#748) 2022-08-17 13:55:06 +01:00
Zsolt Dollenstein
c44ff0500b
Fix license headers (#560)
* Facebook -> Meta

* remove year from doc copyright
2021-12-28 11:55:18 +00:00
Zsolt Dollenstein
45c0d96c06
master -> main (#521) 2021-09-07 11:59:38 +01:00
Jimmy Lai
748ae71909
[docs] add source code links to each class/function (#378) 2020-08-20 17:15:21 -07:00
jimmylai
c023fa7c4c
[typing] enable Pyre strict mode by default (#313)
Co-authored-by: Jimmy Lai <jimmylai@fb.com>
2020-06-12 18:24:18 -07:00
Jimmy Lai
0948108dce add binder link to notebook tutorial page 2019-10-01 13:41:29 -07:00
Jimmy Lai
d55a8bc060 update author in Sphinx conf.py 2019-09-16 19:53:22 -07:00
Jimmy Lai
612cbb0a9e add docstring to ScopeProvider 2019-09-16 19:53:22 -07:00
Jimmy Lai
966ab81a36 add ScopeProvider document 2019-09-16 19:53:22 -07:00
Benjamin Woodruff
da7b9435ee Add logo and favicon to sphinx documentation
- The white logo variant shows up on the top of the sidebar.
- The favicon shows up when the page is loaded.
2019-08-07 13:32:31 -07:00
Benjamin Woodruff
ef0ce06e12 Remove unused sphinx plugins
It doesn't look like we need:

- `sphinx.ext.githubpages`
- `sphinx.ext.todo`
- `sphinx.ext.mathjax`

So I removed these and then sorted the list of extensions.
2019-08-06 19:39:43 -07:00
Benjamin Woodruff
647ef53f0e Finish documentation pass over expressions
This commit mostly focuses on f-strings, collections, comprehensions,
and subscripts/slices.

I added intersphinx support to the sphinx config so I could link to
`ast.literal_eval`.

I exported BaseSimpleComp, since I felt it had some documentation value.
2019-08-06 19:39:43 -07:00
jimmylai
6138e74542
[document] add jupyter based tutorial page
* [document] add jupyter based tutorial page

* add return type and fix typos
2019-08-06 16:34:03 -07:00
Jennifer Taylor
ac1a6fd054 Fix deprecation warning. 2019-08-01 18:28:54 -07:00
jimmylai
88064092af
[document] Use ReadTheDot Theme 2019-08-01 12:09:32 -07:00
Benjamin Woodruff
c0ac3d7049 Switch from automodule to autoclass everywhere
- Now that we're exporting everything from the top-level libcst package,
  automodule makes a mess of things.
- While it does create more boilerplate, using autoclass/autofunction
  instead of automodule gives us a lot more control over the order in
  which nodes are presented, so we can group them by various categories.

This diff also exports BaseParenthesizableWhitespace, because nodes
refer to it by type, and so it's needed for documentation purposes.
2019-07-29 10:51:59 -07:00
jimmylai
14ee31dc6a [doc] Why libcst?
* reuse README intro section in doc

* [doc] Why LibCST?

* reuse README intro section in doc

* [doc] Why LibCST?
2019-07-24 12:19:00 -07:00
Benjamin Woodruff
27e816059b Change autodoc member order to "bysource"
Without this option, autodoc defaults to ordering all members of
modules and classes alphabetically.

While this is normally fine (and probably desirable), the ordering of
fields in dataclasses is significant, so we need to change this behavior
to preserve the original member ordering.
2019-07-23 17:18:32 -07:00
jimmylai
120cfa9229 add sphinx autodoc templates and docs CI job 2019-07-22 20:05:27 -07:00