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

ARROW-446: [Python] Expand Sphinx documentation for 0.3 #656

Closed
wants to merge 9 commits into
base: master
from

Conversation

Projects
None yet
3 participants
@wesm
Member

wesm commented May 7, 2017

I am going to finish the data model section and revamp the Parquet section, so we can get this pushed out with the release announcement tomorrow. We should continue to add a lot of new documentation over the coming weeks

wesm added some commits May 5, 2017

More on Memory/IO section
Change-Id: I042b51f5d4ed25ff636f63eb11927389b8a4fb2c
Add draft about memory/io
Change-Id: I8c6867002799c17c2aa60a50a3056ae624d45a8f
Add section on OSFile, MemoryMappedFile
Change-Id: I30de1c9a78f057d288367eb77681024a7bacc8f8
Add barebones IPC section
Change-Id: Id10ec2e112b6e06c7982ffeef3ebd574ea760fb8
Start on a data model section
Change-Id: I8e5cdda3acf5858cc98f656da208289a59718ab5
@wesm

This comment has been minimized.

Member

wesm commented May 7, 2017

@xhochy I changed away from the RTD Sphinx theme -- I find the code examples, particularly string outputs, to be difficult to read. We can experiment with different themes

-----------------------------
To assist with serialization and deserialization of in-memory data, we have
file interfaces that and read and write to Arrow Buffers.

This comment has been minimized.

@jreback

jreback May 7, 2017

Contributor

can

------------
All memory allocations and deallocations (like ``malloc`` and ``free`` in C)
are tracked in an instance of ``arrow::MemoryPool``. This means that we can the

This comment has been minimized.

@jreback

jreback May 7, 2017

Contributor

then

@wesm

This comment has been minimized.

Member

wesm commented May 7, 2017

Sounds like this is a known issue rtfd/sphinx_rtd_theme#166 -- if we like the RTD theme we'll need to do some customization to improve the code highlighting to improve readability

wesm added some commits May 7, 2017

Install IPython before building docs
Change-Id: Ia30e236ebf1f40f87afd071beda09823ac3d3f26
Finish first cut at data model section
Change-Id: I23c5a70e116e9bf7fe360c26b4a55a05a24c836c
Make a pass over Parquet documentation
Change-Id: Ida3032b335baa80d7a94ced558310c2ea2cc115a
Make pass over Parquet docs
Change-Id: If26796e1eca1c4e4f092bf742e11e56f9039e60f

@wesm wesm changed the title from WIP ARROW-446: [Python] Expand Sphinx documentation for 0.3 to ARROW-446: [Python] Expand Sphinx documentation for 0.3 May 8, 2017

@wesm

This comment has been minimized.

Member

wesm commented May 8, 2017

I'm going to merge as soon as the build passes so I can get the website updated for the release announcement tomorrow

@wesm

This comment has been minimized.

Member

wesm commented May 8, 2017

Can handle more edits and improvements in follow up patches

@asfgit asfgit closed this in cb5e7b6 May 8, 2017

@wesm wesm deleted the wesm:ARROW-446 branch May 8, 2017

@wesm

This comment has been minimized.

Member

wesm commented May 8, 2017

+1

@xhochy

This comment has been minimized.

Member

xhochy commented May 8, 2017

I recently favor more https://pypi.python.org/pypi/sphinx-bootstrap-theme/ (e.g. https://ryan-roemer.github.io/django-cloud-browser/ ) We could probably even customise it so that it looks more like the arrow homepage.

@wesm

This comment has been minimized.

Member

wesm commented May 8, 2017

Sounds fine to me

jeffknupp added a commit to jeffknupp/arrow that referenced this pull request Jun 3, 2017

ARROW-446: [Python] Expand Sphinx documentation for 0.3
I am going to finish the data model section and revamp the Parquet section, so we can get this pushed out with the release announcement tomorrow. We should continue to add a lot of new documentation over the coming weeks

Author: Wes McKinney <wes.mckinney@twosigma.com>

Closes apache#656 from wesm/ARROW-446 and squashes the following commits:

b92c6d2 [Wes McKinney] Make pass over Parquet docs
a46f846 [Wes McKinney] Make a pass over Parquet documentation
066d0b9 [Wes McKinney] Finish first cut at data model section
4f510fb [Wes McKinney] Install IPython before building docs
4885222 [Wes McKinney] Start on a data model section
1d512e9 [Wes McKinney] Add barebones IPC section
0f800d8 [Wes McKinney] Add section on OSFile, MemoryMappedFile
aabf5b2 [Wes McKinney] Add draft about memory/io
5968847 [Wes McKinney] More on Memory/IO section

pcmoritz added a commit to pcmoritz/arrow that referenced this pull request Jun 11, 2017

ARROW-446: [Python] Expand Sphinx documentation for 0.3
I am going to finish the data model section and revamp the Parquet section, so we can get this pushed out with the release announcement tomorrow. We should continue to add a lot of new documentation over the coming weeks

Author: Wes McKinney <wes.mckinney@twosigma.com>

Closes apache#656 from wesm/ARROW-446 and squashes the following commits:

b92c6d2 [Wes McKinney] Make pass over Parquet docs
a46f846 [Wes McKinney] Make a pass over Parquet documentation
066d0b9 [Wes McKinney] Finish first cut at data model section
4f510fb [Wes McKinney] Install IPython before building docs
4885222 [Wes McKinney] Start on a data model section
1d512e9 [Wes McKinney] Add barebones IPC section
0f800d8 [Wes McKinney] Add section on OSFile, MemoryMappedFile
aabf5b2 [Wes McKinney] Add draft about memory/io
5968847 [Wes McKinney] More on Memory/IO section
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment