Skip to content

Commit

Permalink
Update documentation links, again (#123)
Browse files Browse the repository at this point in the history
* Update to new documentation link

* Update contact info
  • Loading branch information
rbsheth committed Jan 6, 2020
1 parent fe22843 commit b340472
Show file tree
Hide file tree
Showing 27 changed files with 63 additions and 64 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Hi,

Please read `contributing guide <https://cpp-pm-hunter.readthedocs.io/en/latest/contributing.html>`__ before sending pull requests or reporting bugs.
Please read `contributing guide <https://hunter.readthedocs.io/en/latest/contributing.html>`__ before sending pull requests or reporting bugs.

Thank you!
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--- If you have a trivial question you can ask it in Gitter room: https://gitter.im/ruslo/hunter -->

* I've read [Brief overview section](https://cpp-pm-hunter.readthedocs.io/en/latest/overview.html) and do understand basic concepts. **[Yes|No]**
* I've read [F.A.Q. section](https://cpp-pm-hunter.readthedocs.io/en/latest/faq.html) and haven't found an answer to my question. **[Yes|No]**
* I've read [Brief overview section](https://hunter.readthedocs.io/en/latest/overview.html) and do understand basic concepts. **[Yes|No]**
* I've read [F.A.Q. section](https://hunter.readthedocs.io/en/latest/faq.html) and haven't found an answer to my question. **[Yes|No]**
* I've read [Code of Conduct](https://github.com/cpp-pm/hunter/blob/master/.github/CODE_OF_CONDUCT.md), I promise to be polite and will do my best at being constructive. **[Yes|No]**

---
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ assignees: ''

---

* I've read [Brief overview section](https://cpp-pm-hunter.readthedocs.io/en/latest/overview.html) and do understand basic concepts. **[Yes|No]**
* I've read [F.A.Q. section](https://cpp-pm-hunter.readthedocs.io/en/latest/faq.html) and there is no solution to my problem there. **[Yes|No]**
* I've read [Brief overview section](https://hunter.readthedocs.io/en/latest/overview.html) and do understand basic concepts. **[Yes|No]**
* I've read [F.A.Q. section](https://hunter.readthedocs.io/en/latest/faq.html) and there is no solution to my problem there. **[Yes|No]**
* I've read [Code of Conduct](https://github.com/cpp-pm/hunter/blob/master/.github/CODE_OF_CONDUCT.md), I promise to be polite and will do my best at being constructive. **[Yes|No]**
* I've read [Reporting bugs section](https://cpp-pm-hunter.readthedocs.io/en/latest/contributing.html#reporting-bugs) carefully. **[Yes|No]**
* I've checked that all the `hunter_add_package`/`find_package` API used by me in the example is the same as in [documentation](https://cpp-pm-hunter.readthedocs.io/en/latest/packages.html). **[Yes|No]**
* I've read [Reporting bugs section](https://hunter.readthedocs.io/en/latest/contributing.html#reporting-bugs) carefully. **[Yes|No]**
* I've checked that all the `hunter_add_package`/`find_package` API used by me in the example is the same as in [documentation](https://hunter.readthedocs.io/en/latest/packages.html). **[Yes|No]**
* I'm using [latest](https://github.com/cpp-pm/hunter/releases) Hunter `URL`/`SHA1`. **[Yes|No]**

<!--- If you can reproduce an issue using just one small CMakeLists.txt, paste it here. -->
Expand Down Expand Up @@ -47,7 +47,7 @@ find_package(boo CONFIG REQUIRED)
Here is the log until first error reported by Hunter, option `HUNTER_STATUS_DEBUG` is `ON`:
* <link-to-log-file>

<!--- Check this document: https://cpp-pm-hunter.readthedocs.io/en/latest/reference/errors/error.external.build.failed.html -->
<!--- Check this document: https://hunter.readthedocs.io/en/latest/reference/errors/error.external.build.failed.html -->
<!--- If you got `external.build.failed` -->
I've checked that the first error in logs **IS NOT** `external.build.failed`. **[Yes|No]**

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/discussion.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ assignees: ''

<!--- If you have a trivial question, you can ask it in Gitter room: https://gitter.im/ruslo/hunter -->

* I've read [Brief overview section](https://cpp-pm-hunter.readthedocs.io/en/latest/overview.html) and do understand basic concepts. **[Yes|No]**
* I've read [F.A.Q. section](https://cpp-pm-hunter.readthedocs.io/en/latest/faq.html) and haven't found an answer to my question. **[Yes|No]**
* I've read [Brief overview section](https://hunter.readthedocs.io/en/latest/overview.html) and do understand basic concepts. **[Yes|No]**
* I've read [F.A.Q. section](https://hunter.readthedocs.io/en/latest/faq.html) and haven't found an answer to my question. **[Yes|No]**
* I've read [Code of Conduct](https://github.com/cpp-pm/hunter/blob/master/.github/CODE_OF_CONDUCT.md), I promise to be polite and will do my best at being constructive. **[Yes|No]**

---
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/package-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ assignees: ''
* This package has no dependencies
* This package has next dependencies:

* `<dependency-1>` (required, available in Hunter: https://cpp-pm-hunter.readthedocs.io/en/latest/packages/pkg/<dependency-1>.html)
* `<dependency-1>` (required, available in Hunter: https://hunter.readthedocs.io/en/latest/packages/pkg/<dependency-1>.html)
* `<dependency-2>` (required, not available in Hunter, corresponding "New package" request: https://github.com/cpp-pm/hunter/issues/<number>)
* `<dependency-3>` (optional, not available in Hunter, corresponding "New package" request: https://github.com/cpp-pm/hunter/issues/<number>)

Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--- Use this part of template if you're adding new package. Remove the rest. -->
<!--- BEGIN -->

* I've followed [this guide](https://cpp-pm-hunter.readthedocs.io/en/latest/creating-new/create/cmake.html)
* I've followed [this guide](https://hunter.readthedocs.io/en/latest/creating-new/create/cmake.html)
step by step carefully. **[Yes|No]**

* I've tested this package remotely and have excluded all broken builds.
Expand All @@ -22,7 +22,7 @@
<!--- Use this part of template if you're updating existing package. Remove the rest. -->
<!--- BEGIN -->

* I've followed [this guide](https://cpp-pm-hunter.readthedocs.io/en/latest/creating-new/update.html)
* I've followed [this guide](https://hunter.readthedocs.io/en/latest/creating-new/update.html)
step by step carefully. **[Yes|No]**

* I've tested this package remotely and have excluded all broken builds.
Expand Down
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ Hunter
CMake driven cross-platform package manager for C/C++.
Linux, Windows, macOS, iOS, Android, Raspberry Pi, etc.

* Documentation: https://cpp-pm-hunter.readthedocs.io
* Brief overview: https://cpp-pm-hunter.readthedocs.io/en/latest/overview.html (**Must-read!**)
* Packages: https://cpp-pm-hunter.readthedocs.io/en/latest/packages.html
* Documentation: https://hunter.readthedocs.io
* Brief overview: https://hunter.readthedocs.io/en/latest/overview.html (**Must-read!**)
* Packages: https://hunter.readthedocs.io/en/latest/packages.html
* Sources: https://github.com/cpp-pm/hunter
* Reporting issues: https://github.com/cpp-pm/hunter/issues/new
* Contributing guide: https://cpp-pm-hunter.readthedocs.io/en/latest/contributing.html
* Contacts: https://cpp-pm-hunter.readthedocs.io/en/latest/contacts.html
* Contributing guide: https://hunter.readthedocs.io/en/latest/contributing.html
* Contacts: https://hunter.readthedocs.io/en/latest/contacts.html
* `Per package testing table <https://github.com/cpp-pm/hunter-testing/branches/all>`_

.. |gitter| image:: https://badges.gitter.im/cpp-pm/community.svg
:target: https://gitter.im/cpp-pm/community
:alt: Gitter public chat room

.. |rtfd| image:: https://readthedocs.org/projects/hunter/badge/?version=latest
:target: http://cpp-pm-hunter.readthedocs.io/en/latest/?badge=latest
:target: http://hunter.readthedocs.io/en/latest/?badge=latest
:alt: Documentation status

.. |travis| image:: https://img.shields.io/travis/cpp-pm/hunter-testing/pkg.gtest.svg?style=flat&logo=travis&label=Linux%20OSX%20Android%20iOS
Expand Down
2 changes: 1 addition & 1 deletion cmake/modules/hunter_error_page.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# All rights reserved.

# Do not move to master - build schemes use this module but they not use master
set(HUNTER_ERROR_PAGE "https://cpp-pm-hunter.readthedocs.io/en/latest/reference/errors")
set(HUNTER_ERROR_PAGE "https://hunter.readthedocs.io/en/latest/reference/errors")

function(hunter_error_page error_page)
message("------------------------------ ERROR -----------------------------")
Expand Down
2 changes: 1 addition & 1 deletion cmake/modules/hunter_finalize.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ macro(hunter_finalize)
if(ANDROID AND CMAKE_VERSION VERSION_LESS "3.7.1")
hunter_user_error(
"CMake version 3.7.1+ required for Android platforms, see"
" https://cpp-pm-hunter.readthedocs.io/en/latest/quick-start/cmake.html"
" https://hunter.readthedocs.io/en/latest/quick-start/cmake.html"
)
endif()

Expand Down
2 changes: 1 addition & 1 deletion cmake/modules/hunter_protected_sources.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ function(hunter_protected_sources package_name)
if(CMAKE_VERSION VERSION_LESS "3.7")
hunter_user_error(
"'hunter_protected_sources' need CMake version 3.7+, see"
" https://cpp-pm-hunter.readthedocs.io/en/latest/quick-start/cmake.html"
" https://hunter.readthedocs.io/en/latest/quick-start/cmake.html"
)
endif()
set("HUNTER_${package_name}_PROTECTED_SOURCES" YES PARENT_SCOPE)
Expand Down
49 changes: 24 additions & 25 deletions docs/contacts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,12 @@ Public
======

* Feel free to open a new `issue`_ if you want to ask a question
* Public chat room on Gitter: https://gitter.im/ruslo/hunter
* Public chat room on Gitter: https://gitter.im/cpp-pm/community

Private
=======

* Write me at ruslan_baratov@yahoo.com
* Private chat room on Gitter: https://gitter.im/ruslo
* Private chat room on Gitter: https://gitter.im/rbsheth

.. _issue: https://github.com/cpp-pm/hunter/issues/new

Expand All @@ -41,25 +40,25 @@ Please don't
"+1", "me too!", "any updates?!", "please please fix it!", etc.
Please use `GitHub reactions <https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/>`__ instead.

Hire
====

I’m available for hire as a freelance developer for all types of Hunter
development (add/maintain/update package, fix bugs, design/implement
new features, etc.) or CMake development (introduce configuration from
scratch, refactor existing code, hunterize, etc.).

Donations
=========

If you like Hunter and its goals, consider supporting it by making a donation.

.. image:: https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif
:target: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=UN8PDZZ3Q7VVL
:alt: PayPal donation

.. image:: https://raster.shields.io/badge/patreon-donate-green.png
:target: https://patreon.com/ruslo
:alt: Patreon donation

Thanks! :)
#Hire
#====
#
#I’m available for hire as a freelance developer for all types of Hunter
#development (add/maintain/update package, fix bugs, design/implement
#new features, etc.) or CMake development (introduce configuration from
#scratch, refactor existing code, hunterize, etc.).
#
#Donations
#=========
#
#If you like Hunter and its goals, consider supporting it by making a donation.
#
#.. image:: https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif
# :target: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=UN8PDZZ3Q7VVL
# :alt: PayPal donation
#
#.. image:: https://raster.shields.io/badge/patreon-donate-green.png
# :target: https://patreon.com/ruslo
# :alt: Patreon donation
#
#Thanks! :)
2 changes: 1 addition & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ If everything seems OK:
and check that issue you have hit is not already fixed/reported
* Check this document if the first error you see is ``external.build.failed``:

* https://cpp-pm-hunter.readthedocs.io/en/latest/reference/errors/error.external.build.failed.html
* https://hunter.readthedocs.io/en/latest/reference/errors/error.external.build.failed.html
* Remove irrelevant code from your example and report one problem at a time.
Try to construct `SSCCE <http://www.sscce.org/>`__. If you need more files
than just ``CMakeLists.txt`` it's better to create separate GitHub repository
Expand Down
2 changes: 1 addition & 1 deletion docs/creating-new/create/cmake.rst
Original file line number Diff line number Diff line change
Expand Up @@ -974,7 +974,7 @@ via Hunter:
|hunter|
.. |hunter| image:: https://img.shields.io/badge/hunter-hunter_box_1-blue.svg
:target: https://cpp-pm-hunter.readthedocs.io/en/latest/packages/pkg/hunter_box_1.html
:target: https://hunter.readthedocs.io/en/latest/packages/pkg/hunter_box_1.html
:alt: Hunter
Example:
Expand Down
2 changes: 1 addition & 1 deletion docs/creating-new/update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,4 +133,4 @@ Once the tests are passing, and all required toolchain modifications have been a
[hunter]> git push -u origin pr.hunter_box_1
Finally, a pull request should be opened to send the package update to the main Hunter repository, as illustrated in the previous section pull request `screen shot <https://cpp-pm-hunter.readthedocs.io/en/latest/creating-new/create/cmake.html#pull-requests>`__ (see `example <https://github.com/ruslo/hunter/pull/1893>`__).
Finally, a pull request should be opened to send the package update to the main Hunter repository, as illustrated in the previous section pull request `screen shot <https://hunter.readthedocs.io/en/latest/creating-new/create/cmake.html#pull-requests>`__ (see `example <https://github.com/ruslo/hunter/pull/1893>`__).
4 changes: 2 additions & 2 deletions docs/old-wiki/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ Cross-platform package manager for C++ (based on CMake ExternalProject).
* Package customization
* [Version and options](https://github.com/ruslo/hunter/wiki/example.custom.config.id)
* [Build type](https://github.com/ruslo/hunter/wiki/example.hunter_configuration_types)
* [Uploading binaries to server](https://cpp-pm-hunter.readthedocs.io/en/latest/faq/why-binaries-from-server-not-used.html#uploading-to-server)
* [Uploading binaries to server](https://hunter.readthedocs.io/en/latest/faq/why-binaries-from-server-not-used.html#uploading-to-server)
* [Multiple HunterGate commands (e.g. projects/subprojects)]
(https://github.com/ruslo/hunter/wiki/usr.multiple.huntergate)

### Tutorials
* [Adding new package](https://cpp-pm-hunter.readthedocs.io/en/latest/creating-new/cmake.html)
* [Adding new package](https://hunter.readthedocs.io/en/latest/creating-new/cmake.html)
* [Adding new package (custom download scheme)]
(https://github.com/ruslo/hunter/wiki/usr.adding.new.package.custom.scheme)

Expand Down
2 changes: 1 addition & 1 deletion docs/packages/pkg/OpenSSL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Fixed/workaround
----------------

- `space in path <https://github.com/openssl/openssl/pull/185>`__,
`related <https://cpp-pm-hunter.readthedocs.io/en/latest/reference/errors/error.spaces.in.hunter.root.html>`__
`related <https://hunter.readthedocs.io/en/latest/reference/errors/error.spaces.in.hunter.root.html>`__
- Can't be build with ``make -jN``:
https://github.com/ruslo/hunter/issues/87

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Explanation
What to do
----------

- In general sequence must looks like this (see also `error.huntergate.before.project <https://cpp-pm-hunter.readthedocs.io/en/latest/reference/errors/error.huntergate.before.project.html>`_):
- In general sequence must looks like this (see also `error.huntergate.before.project <https://hunter.readthedocs.io/en/latest/reference/errors/error.huntergate.before.project.html>`_):

.. code-block:: cmake
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/errors/error.huntergate.before.project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Explanation
What to do
----------

- In general sequence must looks like this (see also `error.hunteraddpackage.after.project <https://cpp-pm-hunter.readthedocs.io/en/latest/reference/errors/error.hunteraddpackage.after.project.html>`_):
- In general sequence must looks like this (see also `error.hunteraddpackage.after.project <https://hunter.readthedocs.io/en/latest/reference/errors/error.hunteraddpackage.after.project.html>`_):

.. code-block:: cmake
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/errors/error.internal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ What to do
----------

Follow this guide to check for known issues and what information needed while filing bug report:
- https://cpp-pm-hunter.readthedocs.io/en/latest/contributing.html#reporting-bugs
- https://hunter.readthedocs.io/en/latest/contributing.html#reporting-bugs
2 changes: 1 addition & 1 deletion docs/reference/errors/error.no.toolchain.info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ What to do
- This may happens because of wrongly created/unsupported toolchain. Please open `new issue <https://github.com/cpp-pm/hunter/issues/new>`_ with information about toolchain you're using.

.. |HUNTER_ENABLED=OFF| replace:: ``HUNTER_ENABLED=OFF``
.. _HUNTER_ENABLED=OFF: https://cpp-pm-hunter.readthedocs.io/en/latest/reference/user-variables.html#hunter-enabled
.. _HUNTER_ENABLED=OFF: https://hunter.readthedocs.io/en/latest/reference/user-variables.html#hunter-enabled
2 changes: 1 addition & 1 deletion docs/reference/errors/error.spaces.in.hunter.root.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ Explanation
What to do
----------

- Set another ``HUNTER_ROOT`` `location <https://cpp-pm-hunter.readthedocs.io/en/latest/reference/errors/error.detect.hunter.root.html>`_ (**recommended**)
- Set another ``HUNTER_ROOT`` `location <https://hunter.readthedocs.io/en/latest/reference/errors/error.detect.hunter.root.html>`_ (**recommended**)
- Set ``HUNTER_ALLOW_SPACES_IN_PATH=ON`` CMake variable to suppress this warning (**not** recommended)
2 changes: 1 addition & 1 deletion docs/reference/internal-modules/hunter_fatal_error.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ will convert

to

* https://cpp-pm-hunter.readthedocs.io/en/latest/reference/errors/error.hunteraddpackage.after.project.html
* https://hunter.readthedocs.io/en/latest/reference/errors/error.hunteraddpackage.after.project.html
2 changes: 1 addition & 1 deletion docs/reference/user-variables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ HUNTER_BINARY_DIR

* Use external directory ``HUNTER_BINARY_DIR`` for building external projects.
This variable can be used to fix
`"path too long" <https://cpp-pm-hunter.readthedocs.io/en/latest/reference/errors/error.external.build.failed.html#windows>`__ error on windows
`"path too long" <https://hunter.readthedocs.io/en/latest/reference/errors/error.external.build.failed.html#windows>`__ error on windows

.. _hunter disable install:

Expand Down
2 changes: 1 addition & 1 deletion examples/Boost-python/config.cmake
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Note: PYTHON_VERSION is optional. Refer to Boost package documentation on how
# and when to use it: https://cpp-pm-hunter.readthedocs.io/en/latest/packages/pkg/Boost.html#cmake-options
# and when to use it: https://hunter.readthedocs.io/en/latest/packages/pkg/Boost.html#cmake-options
hunter_config(Boost VERSION ${HUNTER_Boost_VERSION} CMAKE_ARGS PYTHON_VERSION=${PYTHON_VERSION})
2 changes: 1 addition & 1 deletion examples/Eigen-Boost/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ hunter_add_package(Boost)
# Then try to build Eigen.
# Eigen calls 'find_package(Boost)' but doesn't call 'hunter_add_package(Boost)',
# this leads to conflict similar to the one described in:
# * https://cpp-pm-hunter.readthedocs.io/en/latest/creating-new/cmake-dependencies.html#conflict
# * https://hunter.readthedocs.io/en/latest/creating-new/cmake-dependencies.html#conflict
# Fix: exclude code with 'find_package(Boost)' (this code only for building tests)
# or hunterize Eigen.
hunter_add_package(Eigen)
2 changes: 1 addition & 1 deletion examples/common.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ set(
error_message
"Are you using jenkins.py script for testing?
Please check:
- https://cpp-pm-hunter.readthedocs.io/en/latest/creating-new/create/cmake.html#testing-locally"
- https://hunter.readthedocs.io/en/latest/creating-new/create/cmake.html#testing-locally"
)

### Check testing variables are set
Expand Down
2 changes: 1 addition & 1 deletion scripts/create-toolchain-info.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ if(NOT HUNTER_SELF)
message("[hunter ** INTERNAL **] [Directory:${CMAKE_CURRENT_LIST_DIR}]")
message("")
message("------------------------------ ERROR ------------------------------")
message(" https://cpp-pm-hunter.readthedocs.io/en/latest/reference/errors/error.internal.html")
message(" https://hunter.readthedocs.io/en/latest/reference/errors/error.internal.html")
message("-------------------------------------------------------------------")
message(FATAL_ERROR "")
endif()
Expand Down

0 comments on commit b340472

Please sign in to comment.