8000 Auto generate docs with sphinx by mbichoffe · Pull Request #442 · twilio/twilio-python · GitHub
[go: up one dir, main page]
Skip to content

Auto generate docs with sphinx #442

New issue
8000

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

Sign up for GitHub

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

Merged
merged 20 commits into from
Aug 3, 2018
Merged

Auto generate docs with sphinx #442

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
53437e4
Change 'make docs-install' command to install Sphinx and Twilio libra…
mbichoffe Jul 27, 2018
200900d
update gitignore to ignore build directories
mbichoffe Jul 30, 2018
98e6e19
Add docs directory and Makefile
mbichoffe Jul 30, 2018
6808032
add config file
mbichoffe Jul 30, 2018
fab86d0
add sidebar template;
mbichoffe Jul 30, 2018
4061c61
adds index directive
mbichoffe Jul 30, 2018
a7f92bd
adds readme to autogenerated docs
mbichoffe Jul 30, 2018
f6a5829
Clean up source/_rst directory before calling sphinx-apidoc
mbichoffe Jul 31, 2018
ced3bf0
Remove unnecessary commands
mbichoffe Jul 31, 2018
0b894b6
Remove twilio lib from doc-install
mbichoffe Jul 31, 2018
c55b271
Add twilio relative import
mbichoffe Jul 31, 2018
6b7d9ea
add glob flag and _rst/module directive
mbichoffe Jul 31, 2018
b4fb42e
add _rst directory
mbichoffe Jul 31, 2018
05284fc
Update master doc location
mbichoffe Jul 31, 2018
615d5ae
fiiiine, added all sphinx make commands to this file and removed docs…
mbichoffe Jul 31, 2018
a4cdd87
address code review comments
mbichoffe Aug 1, 2018
d788c3d
specify docs directories to ignore
mbichoffe Aug 1, 2018
b889bdf
address code review comments
mbichoffe Aug 1, 2018
d6c49ea
bump Sphinx version
mbichoffe Aug 1, 2018
7a6eb0e
address code review comment
mbichoffe Aug 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
address code review comments
  • Loading branch information
@mbichoffe
mbichoffe committed Aug 1, 2018
commit a4cdd87813043884a58712fd4e33612746cc1d04
4 changes: 2 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ docs-install:
. venv/bin/activate; pip install -U sphinx
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe better to use pip install -r tests/requirements.txt? It looks like we already require sphinx 1.4.9 there.


docs:
-rm -rf source/_rst/*
-rm -rf build/*
-rm -rf docs/source/_rst
-rm -rf docs/build/*
. venv/bin/activate; sphinx-apidoc -f twilio -o docs/source/_rst
. venv/bin/activate; sphinx-build -b html -c ./docs -d docs/build/doctrees . docs/build/html
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how does sphinx-build know where to find index.rst?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's on conf.py and the -c flag indicates where the conf file lives


Expand Down
0