Skip to content

Commit

Permalink
Remove txt2tags dependency (use markdown instead)
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterPetrik committed Jun 10, 2020
1 parent 2bcb63e commit dcd017a
Show file tree
Hide file tree
Showing 24 changed files with 3,885 additions and 14,778 deletions.
1,623 changes: 0 additions & 1,623 deletions INSTALL

This file was deleted.

1,554 changes: 1,554 additions & 0 deletions INSTALL.md

Large diffs are not rendered by default.

3,316 changes: 0 additions & 3,316 deletions NEWS

This file was deleted.

1,016 changes: 444 additions & 572 deletions doc/NEWS.t2t → NEWS.md

Large diffs are not rendered by default.

7 changes: 3 additions & 4 deletions README.md
Expand Up @@ -60,9 +60,8 @@ modified.
## Note

Please follow the installation instructions carefully.
After extracting the distribution, you can find the HTML version of the
installation document in `qgis/doc/index.html`. The installation document is
also available as PDF in the same directory.
After extracting the distribution, please check the
[documentation](https://qgis.org/en/docs/index.html)

## Help us
Please submit bug reports using the [QGIS bug tracker](https://github.com/qgis/QGIS/issues/).
Expand Down Expand Up @@ -93,4 +92,4 @@ If you are not a developer, there are many other possibilities which do not requ

### Building from source

The [building guide](http://htmlpreview.github.io/?https://raw.github.com/qgis/QGIS/master/doc/INSTALL.html) can be used to get started with building QGIS from source.
The [building guide](INSTALL.md) can be used to get started with building QGIS from source.
94 changes: 0 additions & 94 deletions cmake/Txt2Tags.cmake

This file was deleted.

5 changes: 2 additions & 3 deletions debian/qgis-common.install
@@ -1,15 +1,14 @@
usr/share/qgis/doc/AUTHORS
usr/share/qgis/doc/CONTRIBUTORS
usr/share/qgis/doc/DONORS
usr/share/qgis/doc/INSTALL
usr/share/qgis/doc/INSTALL.html
usr/share/qgis/doc/INSTALL.md
usr/share/qgis/doc/SPONSORS
usr/share/qgis/doc/TRANSLATORS
usr/share/qgis/doc/developersmap.html
usr/share/qgis/doc/favicon.ico
usr/share/qgis/doc/images
usr/share/qgis/doc/index.html
usr/share/qgis/doc/NEWS
usr/share/qgis/doc/NEWS.md
usr/share/qgis/doc/NEWS.html
usr/share/qgis/doc/nohelp.html
usr/share/qgis/doc/style.css
Expand Down
25 changes: 2 additions & 23 deletions doc/CMakeLists.txt
@@ -1,33 +1,12 @@
# include doxygen documentation
SET (WITH_APIDOC FALSE CACHE BOOL "Determines whether the QGIS API doxygen documentation should be built")

# include doxygen documentation
SET (WITH_TXT2TAGS_PDF FALSE CACHE BOOL "Determines whether PDF should be generate for the txt2tags documentation")

# include Qt documentation
SET (QT_DOC_URL "https://doc.qt.io/qt-5/" CACHE STRING "URL for Qt docs")

INCLUDE(Txt2Tags)
FIND_TXT2TAGS()

IF(TXT2TAGS_EXECUTABLE)
ADD_TXT2TAGS_FILES(QGIS_DOC_FILES INSTALL.t2t NEWS.t2t)
IF(WITH_TXT2TAGS_PDF)
ADD_TXT2TAGS_PDFS(QGIS_DOC_FILES INSTALL.t2t NEWS.t2t)
ENDIF(WITH_TXT2TAGS_PDF)
FILE(GLOB t2tfiles doc/*.t2t)
ADD_CUSTOM_TARGET (t2tdoc ALL DEPENDS ${QGIS_DOC_FILES} ${t2tfiles})
ELSE(TXT2TAGS_EXECUTABLE)
SET(QGIS_DOC_FILES
../INSTALL
../NEWS
INSTALL.html
NEWS.html
)
ENDIF(TXT2TAGS_EXECUTABLE)

SET(QGIS_DOC_FILES
${QGIS_DOC_FILES}
../INSTALL
../NEWS
index.html
developersmap.html
nohelp.html
Expand Down

2 comments on commit dcd017a

@nirvn
Copy link
Contributor

@nirvn nirvn commented on dcd017a Jun 10, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PeterPetrik , @nyalldawson , commit caused a regression preventing a successful make install:

CMake Error at doc/cmake_install.cmake:41 (file):
  file INSTALL cannot find "/home/webmaster/dev/cpp/QGIS/doc/../INSTALL": No
  such file or directory.
Call Stack (most recent call first):
  cmake_install.cmake:58 (include)

@PeterPetrik
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.