What Sphinx changes on gh-pages branch

19 views
Skip to first unread message

bradley...@gmail.com

unread,
Oct 20, 2020, 10:57:59 AM10/20/20
to sphinx-users
I am using sphinx to build my github pages.
When a file <name>.rst changes, I get changes in the following files:

.doctrees/environment.pickle
.doctrees/<name>.doctree
_sources/<name>.rst.txt
 objects.inv
<name>.html

I like to update my documentation corresponding to the master branch (the bleeding edge) often. This includes changes to the release notes that say what is different each time. I am worried that worried that this will cause the size of my github repository to grow significantly. Has this been a problem ? Is sphinx designed with this use case in mind ?

Komiya Takeshi

unread,
Nov 12, 2020, 12:51:54 PM11/12/20
to sphinx...@googlegroups.com
Hi,

The files under `.doctrees` directory are generated on building as
intermediate file. So they don't need to be committed to your repo. So
please remove them before committing (or give `-d` option to create it
outside of your repo).

Thanks,
Takeshi KOMIYA

2020年10月20日(火) 23:58 bradley...@gmail.com <bradley...@gmail.com>:
> --
> You received this message because you are subscribed to the Google Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/03c1a340-f3f3-4ce0-a372-9b5100cea7e5n%40googlegroups.com.

bradley...@gmail.com

unread,
Nov 13, 2020, 6:09:48 AM11/13/20
to sphinx-users
Thanks: Removing the `.doctrees` directory works.
I thought `.doctrees` might be used for  navigating or searching or both.

Daniel Scott

unread,
Nov 25, 2020, 10:27:23 PM11/25/20
to sphinx...@googlegroups.com
--
Reply all
Reply to author
Forward
0 new messages