Skip to content

docs theme #135

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

Merged
merged 6 commits into from
Sep 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ project.
Project Info
------------

- Homepage: `https://pypi.python.org/pypi/PyDrive2 <https://pypi.python.org/pypi/PyDrive2>`_
- Documentation: `Official documentation on GitHub pages <https://iterative.github.io/PyDrive2/docs/build/html/index.html>`_
- GitHub: `https://github.com/iterative/PyDrive2 <https://github.com/iterative/PyDrive2>`_
- Package: `https://pypi.python.org/pypi/PyDrive2 <https://pypi.python.org/pypi/PyDrive2>`_
- Documentation: `https://docs.iterative.ai/PyDrive2 <https://docs.iterative.ai/PyDrive2>`_
- Source: `https://github.com/iterative/PyDrive2 <https://github.com/iterative/PyDrive2>`_
- Changelog: `https://github.com/iterative/PyDrive2/releases <https://github.com/iterative/PyDrive2/releases>`_
- `Running tests </pydrive2/test/README.rst>`_

Features of PyDrive2
Expand Down
13 changes: 0 additions & 13 deletions docs/README

This file was deleted.

27 changes: 27 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
This document outlines how to rebuild the documentation.

## Setup

- Install Sphinx: `pip install sphinx` or `apt-get install python-sphinx`
- Install theme: `pip install furo`
- Build site: `sphinx-build docs dist/site -b dirhtml -a`

Updating GitHub Pages:

```bash
cd dist/site
git init
git add .
git commit -m "update pages"
git branch -M gh-pages
git push -f git@github.com:iterative/PyDrive2 gh-pages
```

## Contributing

If code files were added, the easiest way to reflect code changes in the
documentation by referencing the file from within `pydrive.rst`.

If a non-code related file was added (it has to have the `.rst` ending),
then add the file name to the list of names under "Table of Contents"
in `index.rst`. Make sure to add the file name excluding the `.rst` file ending.
Binary file removed docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file removed docs/build/doctrees/filelist.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/filemanagement.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/index.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/oauth.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/pydrive2.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/quickstart.doctree
Binary file not shown.
4 changes: 0 additions & 4 deletions docs/build/html/.buildinfo

This file was deleted.

43 changes: 0 additions & 43 deletions docs/build/html/_sources/filelist.rst.txt

This file was deleted.

253 changes: 0 additions & 253 deletions docs/build/html/_sources/filemanagement.rst.txt

This file was deleted.

Loading