Commit Graph

73 Commits

Author SHA1 Message Date
Mateusz Łoskot
cb5b2e0ece
doc/README.md: clarify steps building docs [ci skip] 2019-11-04 23:09:14 +01:00
Mateusz Łoskot
fbec8a3aa4
[doc] Split design guide into multiple pages (#389)
Improve some titles and re-arrange several sections (e.g. in Metafunctions).
Remove section about I/O extension from design guide as outdated and
unnecessary (in design guide).
2019-09-06 17:09:23 +02:00
Mateusz Łoskot
e7d8f1eeec
[doc] Point link to download to GitHub not self, the website 2019-09-03 22:02:03 +02:00
Mateusz Łoskot
3a668fbe14
[doc] Indicate GIL is C++11 library 2019-09-03 21:04:58 +02:00
Mateusz Łoskot
1f75e85300
[doc] Remove incomplete copyright info from Sphinx config [ci skip] 2019-09-03 20:21:40 +02:00
Mateusz Łoskot
968cc0847b
[doc] Remove incorrect and confusing version number from Sphinx config 2019-09-03 20:16:23 +02:00
Mateusz Łoskot
6f7d0a1180
[doc] Add footer with 'last built on' timestamp and Sphinx version
Since list of contributors who are copyright holders is quite long,
remove the copyright information from the footer. It would be better
to add acknowledgments and contributors list on separate page, or
simply link to https://github.com/boostorg/gil/graphs/contributors
2019-09-03 20:07:49 +02:00
Mateusz Łoskot
b342bdd462
[doc] Improve structure of image_processing/ node 2019-09-03 18:10:04 +02:00
Mateusz Łoskot
a2b582c2c6
[doc] Remove superfluous .rst extension from pages listing
Move image processing sections before I/O extension page.
Refines #388
2019-09-03 14:33:19 +02:00
Olzhas Zhumabek
6d61de0765
Image Processing docs (#388)
* Fill values, links and images

This commit fills in the template
left by the previous commit

* Replace Mathjax with code blocks

Since GitHub doesn't allow Mathjax,
the formula parts have been replaced
with code blocks

* Remove section on affine transformation

It doesn't seem like the concept is
used often, so postponed for now

* Add basic explanation of convolution

* Docs for Harris and Hessian

The docs are written with a beginner
in mind and has a basics section.
The pictures and paper links are to be
inserted.

* Convert markdown to rst

* Add some more relevant papers

This commit cites and adds a link to
paper about Hessian detector and
a review paper about affine region
detectors

* Move to new concept name

Space extrema detector doesn't seem to
be a widespread usage of detector the
detector class. There is a paper
that uses "Affine region detector"
term, which has quite a few citations

* Fix mistakes in docs

Fix mistakes related to terminology
and algorithm steps

* Add ip docs to index.rst

Make sure ip docs are built and are
in the final output

* Fix formatting

It seems like some lines are not
properly formatted and rendered file
containes unreadable lines. Fixed
by not formatting it.
2019-09-03 08:43:41 +06:00
Mateusz Łoskot
308e4eafa4
Fix Sphinx syntax of code-block directive 2019-08-05 12:31:43 +02:00
Mateusz Łoskot
8b616b686c
Clarify what flavours of PNM formats can be read and written (#358) 2019-07-30 08:11:26 +02:00
Mateusz Łoskot
d86e4a4dec
Bump Sphinx version from 1.7.9 to 2.1 (#346)
Fixes #345
2019-07-22 01:49:47 +02:00
Mateusz Łoskot
6b181acce2
[doc] Split tutorial into separate documents for quickstart section [ci skip] (#325)
Split the table of contents into two section:
  - Quickstart materials
  - Detailed documentation
Move doc/before_after.dox to tutorial/histogram.rst (closes #286).
Tidy up tutorial reST paragraphs, mark-up and code samples.
2019-07-21 20:54:03 +02:00
Mateusz Łoskot
69adf0e8a5
Fix ENABLE_GRAY_ALPHA macro name to BOOST_GIL_IO_ENABLE_GRAY_ALPHA 2019-07-17 22:05:13 +02:00
Mateusz Łoskot
2bdaa622bf
Add Image Processing section to Doxygen-based docs (#334) [ci skip] 2019-07-12 15:56:52 +01:00
Mateusz Łoskot
5ec5566fe4
[doc] Removed unused files (#327) [ci skip]
The following files have been deleted:

- doc/adobe_logo.gif
- doc/adobe_source.css
- doc/boost.png
- doc/build.sh
- doc/rst.css
- doc/shorten_file_name.sh
2019-07-09 09:45:18 +02:00
Mateusz Łoskot
c3e84adbd7
[doc] Fix incomplete code-block directive [skip appveyor]
Tidy up paragraph reformatting.
2019-07-08 19:08:26 +02:00
Mateusz Łoskot
7a51663dd8
[doc] Fix inconsistent reST sections markup [skip appveyor]
Use code-block directive for code blocks.
Apply 79 line length limit to according to doc8 linter for Python
and reStructuredText.

[skip azp]
2019-07-08 18:09:54 +02:00
Mateusz Łoskot
5406038385
Add documentation build steps to doc/README.md 2019-07-08 18:09:35 +02:00
Mateusz Łoskot
4ed7701b47
Move tests of extensions inside test/ directory (#302)
Split header tests accordingly i.e. test core headers as part of
core tests, numeric extension headers as part of numeric tests, etc.

It extends the convention of sub-directories already established in
`include/boost/gil` directory. It is sensible to follow it in other
areas of the source tree (i.e. `test/`, `doc/` and `benchmark/`).

Another important reason to move the tests is to enable removal of
the top-level `Jamfile` with all its definitions of test-specific
requirements.
The top-level `Jamfile` is not advised, especially if it specifies
build requirements like C++ language version.
Those affect non-tests builds e.g. documentation, causing failures
during generation of HTML documentation (leads to missing docs).
2019-05-28 18:58:22 +02:00
Mateusz Łoskot
f88b1cd16c
Restore copyright notice removed by accident [ci skip]
It was removed in ecc19de7c9
2019-05-21 11:31:53 +02:00
Mateusz Łoskot
8c331a55fe
[doc] Move Pixel Locator out of Pixel Iterator section (#288) [ci skip] 2019-04-24 21:59:54 +02:00
Mateusz Łoskot
6a5772144b
Document purpose of cached_location_t [ci skip] (#287)
Closes #130
2019-04-16 00:31:45 +02:00
Mateusz Łoskot
d5348c6c61
Remove doc/doxygen/design_guide.dox as old docs remains (#285)
Closes #285
2019-04-15 23:16:11 +02:00
Nikita Kniazev
33d4ac05ae Use just ::value where is possible (#262)
The ::value member is common convention of all MPL and TypeTraits metafunctions.

Fixes VS2015 failures (#261)
2019-03-19 20:34:11 +01:00
Mateusz Łoskot
4905e606fa
Update INPUT list in doc/doxyfile (#254)
Make peace with @vinniefalco & @pdimov, not war!
2019-03-07 14:40:28 +01:00
Mateusz Łoskot
8429300aae
Trim annoying whitespaces in doc/doxyfile [ci skip] 2019-03-07 09:24:19 +01:00
Mateusz Loskot
a2b2ca977a
Replace BOOST_STATIC_CONSTANT with constexpr (#211)
Tidy up formatting of refactored parts of code.
2019-01-12 23:57:35 +01:00
Mateusz Loskot
6e3ccc00b1
Remove dependency on Boost.StaticAssert (#207)
Replaced BOOST_STATIC_ASSERT with C++11 binary static_assert,
with empty message.

In future, this should make it possible to automatically refactor
into C++17 unary static_assert using clang-tidy and
its modernize-unary-static-assert check.

Closes #106
2019-01-11 10:33:09 +01:00
Mateusz Loskot
032a4786bb
Remove unnecessary extern C around libraw.h include (#178)
Since libraw is C++ library, not C, it is always built as C++ library.
2018-12-09 21:38:59 +01:00
Samuel Debionne
edcc912ceb Update design_guide.rst (#172)
Follows up #83 that replaced bitsN[s] aliases with C++11 types
2018-12-06 13:41:13 +01:00
Mateusz Łoskot
42a14c1f4c
Fix Sphinx warnig about html_add_permalinks type [ci skip]
WARNING: The config value `html_add_permalinks' has type `bool',
         defaults to `str'.
2018-11-20 19:41:36 +01:00
Mateusz Łoskot
c683fd45b1
Remove Exhale from doc/requirements.txt [ci skip] 2018-11-20 16:09:19 +01:00
Mateusz Łoskot
4bd08aac67
Start doc/README.md document [ci skip]
Add Python pip requirements.txt (preparing for Exhale prototype).
2018-11-20 15:59:01 +01:00
Mateusz Loskot
ce82941fa2
Rename point2<T> to point<T> (#155)
Add point2<T> alias template for backward compatibility with Boost <=1.68.
Replace multiple point_t aliases of point<ptrdiff_t> with single defined
in point.hpp. The point_t is common used to represent dimensions.
Replace many uses of point<ptrdiff_t> with point_t.

Apply reformatting around point2 changes to respect the line length limit.

Follows up discussion in #154
2018-10-19 09:32:23 +02:00
Mateusz Łoskot
32fec9f05b
Refactor library includes to #include <boost/gil/...>
Group include directives, sort within group:
* In headers of GIL core and extensions:
  1. boost/gil/extension/*
  2. boost/gil/*
  3. boost/*
  4. C++ standard library headers
* In programs:
  1. boost/gil/*
  2. boost/*
  3. C++ standard library headers
  4. "xxx.hpp" for local headers
Add basic guidelines to CONTRIBUTING.md.
Add/Remove #include <boost/config.hpp> or std headers un/necessary.
Rename gil_concept.hpp to concepts.hpp.
Remove gil_all.hpp - we already have all-in-one boost/gil.hpp.
Tidy up and unify copyright and license header.
Tidy up formatting and excessive whitespaces in some comments.
Remove Doxygen block with file description, author, date, etc.
Remove dead or commented pragmas and directives.
Trim trailing whitespaces.
2018-09-28 16:26:34 +02:00
Mateusz Łoskot
ecc19de7c9
Simplify and clean up Jamfiles
Rename Jamfile.v2 to Jamfile - BBV1 is dead.
Remove numeric/test/test.cpp as redundant.
2018-09-21 18:02:37 +02:00
Mateusz Łoskot
837dbd9a3c [doc] Embed original video by Lubomir Bourdev in Tutorial
This video lecture was originally published at
https://stlab.adobe.com/gil/presentation/index.htm

Boost.GIL maintainers received agreement from Lubomir Bourdev to
copy and preseve the original video:
https://lists.boost.org/boost-gil/2018/06/0032.php

The lecture has also been archived by Sean Parent (Adobe) at
https://youtu.be/RjNz_sl-eXk
Thanks to Sean for sharing .MOV file he captured from the original server.
2018-07-03 17:29:07 +02:00
Mateusz Łoskot
30c249de9e [doc] Add BOOST_GIL_DOXYGEN_ONLY to Doxyfile [ci skip]
To be used as #ifdef test for definitions that should be preprocessed
only by Doxygen, but skipped during normal compilation.
2018-06-27 00:02:27 -04:00
Mateusz Łoskot
0963021f8b [doc] Remove unused Doxygen predefine ADOBE_GIL_STANDALONE_DOCUMENTATION [ci skip] 2018-06-27 00:02:27 -04:00
Stefan Seefeld
148aefdf1a Fix cross-references. 2018-06-27 00:02:27 -04:00
Stefan Seefeld
1015e71279 Update documentation for new IO extension file layout. 2018-06-27 00:02:27 -04:00
Stefan Seefeld
fbefe8963e Doc (#73)
* Enable autosectionlabel extension.
* Fix various references.
* Update documentation for new IO extension file layout.
2018-06-27 00:02:27 -04:00
Mateusz Loskot
51431b389f [doc] Tabs to spaces
[ci skip]
2018-06-27 00:02:27 -04:00
Mateusz Loskot
a0335281a0 Tidy up, typos, re-flow
[ci skip]
2018-06-27 00:02:27 -04:00
Mateusz Loskot
fef646ede1 Move links at the end of file
This seems to be Sphinx recommended convention.
2018-06-27 00:02:27 -04:00
Mateusz Loskot
722901f1dc Tidy up, re-flow tutorial.rst 2018-06-27 00:02:27 -04:00
Mateusz Loskot
dc5fc1d46c Tidy up, re-flow, mark inline code parts in io.rst 2018-06-27 00:02:27 -04:00
Stefan Seefeld
40477cfc09 Use boost/gil.hpp in docs. 2018-06-27 00:02:27 -04:00