Skip to content
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.

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

Jump to bottom

Write more documentation and examples #45

Open
5 of 12 tasks
myselfhimself opened this issue Jun 26, 2020 · 5 comments
Open
5 of 12 tasks

Write more documentation and examples #45

myselfhimself opened this issue Jun 26, 2020 · 5 comments
Assignees
@myselfhimself
Labels
documentation Improvements or additions to documentation

Comments

@myselfhimself
Copy link
Owner

myselfhimself commented Jun 26, 2020 •
edited
Loading

  • sync tutorial 1 code + readthedocs wiki counterpart
  • tutorial 2: add pixel access and finish stylize example with last image selection
  • write more user documentation in the docs/ directory for the readthedocs web reader
  • add more examples in the examples/ directory
  • add sphinx gmic directive to generate pictures at build time for most gmic commands
  • add pythonic badges to README as the python-related ones here
  • finish Installing page
  • finish Quickstart GmicImage section
  • finish Quickstart numpy section
  • write numpy-specific section showcasing the w,h,d,s <=> d,h,w,s inversion between numpy/PIL and gmic
  • add link to hello world example
  • add link to picsum example

Especially target beginners!! The G'MIC language is not so well known compared to how the G'MIC Qt Widget in graphics software suites.

🍕
@myselfhimself
Copy link
Owner Author

Especially write the numpy i/o doc related to the LibreGraphicsMeeting video

myselfhimself added a commit that referenced this issue Aug 21, 2020
@myselfhimself
#43 #45 adding CONTRIBUTING file for developers
e9273bb
myselfhimself added a commit that referenced this issue Aug 24, 2020
@myselfhimself
#43 #45 adding CONTRIBUTING file for developers
268f92d
myselfhimself added a commit that referenced this issue Aug 24, 2020
@myselfhimself
#45 beginning of more gmic-py readthedocs documentation
d2a6be8
myselfhimself added a commit that referenced this issue Aug 25, 2020
@myselfhimself
#45 rst vs md doc format troubleshooting
04157f5
myselfhimself added a commit that referenced this issue Aug 25, 2020
@myselfhimself
#45 troubleshooting readthedocs build
41754c4
myselfhimself added a commit that referenced this issue Aug 25, 2020
@myselfhimself
#45 readthedocs troubleshooting
2bb42a9
myselfhimself added a commit that referenced this issue Aug 25, 2020
@myselfhimself
#45 documenting documentation writing for contributors
a899191
myselfhimself added a commit that referenced this issue Aug 25, 2020
@myselfhimself
#45 docs: troubleshooting side pages
5c8eeb5
myselfhimself added a commit that referenced this issue Aug 25, 2020
@myselfhimself
#45 docs: rst to md
b91cef9
myselfhimself added a commit that referenced this issue Aug 25, 2020
@myselfhimself
#45 docs: more on local sphinx use
a28270e
myselfhimself added a commit that referenced this issue Aug 25, 2020
@myselfhimself
#45 adding custom Sphinx gmicpic directive for display gmic command i…
df3a749 
…mages inline
myselfhimself added a commit that referenced this issue Aug 25, 2020
@myselfhimself
#45 gmicpic: adding requirements for readthedocs.io
73c63e4
myselfhimself added a commit that referenced this issue Aug 25, 2020
@myselfhimself
#45 gmicpic: adding offline image sample
14b7978
myselfhimself added a commit that referenced this issue Aug 25, 2020
@myselfhimself
#45 docs: gmicpic directive i/o params rewriting
182c3ec
myselfhimself added a commit that referenced this issue Aug 25, 2020
@myselfhimself
#45 docs: gmicpic: adding missing samples
01d1211
myselfhimself added a commit that referenced this issue Aug 26, 2020
@myselfhimself
#45 docs: switching to externalized gmic-sphinx extension
4e3490d
myselfhimself added a commit that referenced this issue Aug 28, 2020
@myselfhimself
#45 documented developer's lifecycle
147e94d
myselfhimself added a commit that referenced this issue Aug 28, 2020
@myselfhimself
#45 docs fixing
6856566
myselfhimself added a commit that referenced this issue Aug 28, 2020
@myselfhimself
#45 doc: compiling: removing redundant command output
abe1fda
myselfhimself added a commit that referenced this issue Aug 28, 2020
@myselfhimself
#45 75% getting started documentation
fc50864
myselfhimself added a commit that referenced this issue Sep 1, 2020
@myselfhimself
#45 fixed installing page format
d9e641a
myselfhimself added a commit that referenced this issue Sep 3, 2020
@myselfhimself
#45 #58 #59 more numpy doc, doc logo, css styling
4985afb
myselfhimself added a commit that referenced this issue Sep 3, 2020
@myselfhimself
#43 #45 #58 fix index doc; document documenting; add simplified doc-g…
92bc958 
…eneration command
myselfhimself added a commit that referenced this issue Sep 24, 2020
@myselfhimself
#45 adding helloworld and picsum.photos random montage examples
e604d00
myselfhimself added a commit that referenced this issue Sep 24, 2020
@myselfhimself
#45 python examples reformatting
aedcd6b
myselfhimself added a commit that referenced this issue Nov 16, 2020
@myselfhimself
#45 tutorial 1 ReST
5a86760
myselfhimself added a commit that referenced this issue Nov 17, 2020
@myselfhimself
#45 tutorial 2 on pythonic gmic
bfefb47
myselfhimself added a commit that referenced this issue Nov 19, 2020
@myselfhimself
#45 tutorial 2 on pythonic gmic(2)
520373b
myselfhimself added a commit that referenced this issue Nov 20, 2020
@myselfhimself
#45 tutorial 2 on pythonic gmic(3)
a3273a7
myselfhimself added a commit that referenced this issue Dec 4, 2020
@myselfhimself
#43 #45 manylinux: more pybin pattern filtering (audithweel)
eeca6e1
myselfhimself added a commit that referenced this issue Dec 4, 2020
@myselfhimself
#43 #45 manylinux: more pybin pattern filtering (audithweel) (2)
4a659b1
myselfhimself added a commit that referenced this issue Dec 9, 2020
@myselfhimself
#45 #82 removing libcurl dependency, document requirement for curl ex…
4096471 
…ecutable
myselfhimself added a commit that referenced this issue Dec 9, 2020
@myselfhimself
#82 #45 releasing 291 alpha6
1006b6d
myselfhimself added a commit that referenced this issue Dec 10, 2020
@myselfhimself
#45 doc targetting 2.9.1alpha6, adding wget next to curl as network a…
51368ef 
…uxiliary
myselfhimself added a commit that referenced this issue Dec 10, 2020
@myselfhimself
#45 fixing parameterless doc generating command
8f18f63
myselfhimself added a commit that referenced this issue Dec 10, 2020
@myselfhimself
#45 adding documentation to pypi.org home side-links, cleaning comments
3864d33
myselfhimself added a commit that referenced this issue Dec 10, 2020
@myselfhimself
#45 tutorial 3 now 35% done
63f2355
myselfhimself added a commit that referenced this issue Dec 15, 2020
@myselfhimself
#45 README examples
bcd684b
myselfhimself added a commit that referenced this issue Dec 15, 2020
@myselfhimself
#45 README jupyter examples, community links
8e41883
myselfhimself added a commit that referenced this issue Dec 15, 2020
@myselfhimself
#45 README jupyter examples (2)
018cd8f
myselfhimself added a commit that referenced this issue Dec 15, 2020
@myselfhimself
#45 README jupyter examples (3)
212bdf5
myselfhimself added a commit that referenced this issue Dec 16, 2020
@myselfhimself
#45 gitignore docs' build directory
416cb43
myselfhimself added a commit that referenced this issue Dec 16, 2020
@myselfhimself
#45 adding tutorial 2 example image result
914d9f6
myselfhimself added a commit that referenced this issue Dec 16, 2020
@myselfhimself
#45 tutorial 3 progress 70%
ee6f234
myselfhimself added a commit that referenced this issue Dec 16, 2020
@myselfhimself
#45 tutorial 3 progress 70% (2)
9aafcc7
myselfhimself added a commit that referenced this issue Dec 17, 2020
@myselfhimself
#45 tutorial 3 memory overhead fix attempt
0afd393
myselfhimself added a commit that referenced this issue Dec 18, 2020
@myselfhimself
#45 tutorial 3 memory overhead fix attempt (2)
af289bd
myselfhimself added a commit that referenced this issue Dec 18, 2020
@myselfhimself
#45 tutorial 3 progress
1092f57
myselfhimself added a commit that referenced this issue Dec 21, 2020
@myselfhimself
#46 #45 finishing tutorial3, backing up tutorials 4 and 5
a1bf1b7
myselfhimself added a commit that referenced this issue Dec 21, 2020
@myselfhimself
#46 #45 adding example 4 WIP README
185d3bc
@myselfhimself
Copy link
Owner Author

@myselfhimself
Copy link
Owner Author

Memory issue is solved, gmic-py's readthedocs jobs have been kindly moved by the admin team from a 4Gb to a 8Gb ram builder.

myselfhimself added a commit that referenced this issue Dec 22, 2020
@myselfhimself
#45 tutorial 3 surface optimizing rework
7d00793
myselfhimself added a commit that referenced this issue Dec 22, 2020
@myselfhimself
Revert "#45 tutorial 3 surface optimizing rework"
b0df2ca 
This reverts commit 7d00793.
myselfhimself added a commit that referenced this issue Dec 22, 2020
@myselfhimself
#45 renaming tutorial3, discarding references to tutorial 5
459a81a
myselfhimself added a commit that referenced this issue Dec 22, 2020
@myselfhimself
#45 updating example 3's README link to tutorial 3
3e45f28
myselfhimself added a commit that referenced this issue Dec 23, 2020
@myselfhimself
#71 #43 #45 auto-version in docs/ conf
3cd0a50
@myselfhimself myselfhimself self-assigned this Apr 11, 2021
@myselfhimself myselfhimself added the documentation Improvements or additions to documentation label Apr 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@myselfhimself myselfhimself

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@myselfhimself