amass/qtpromise
1
0
Fork 0
mirror of https://github.com/simonbrunel/qtpromise.git synced 2025-07-05 16:55:23 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add CMake support and enhance the getting started docs

Browse Source 
- Add a root CMakeLists.txt defining an INTERFACE target.
- Add CMake, qpm, Git and download installation instructions.
- Add CMake and qmake integration instructions.
- Remove smooth scroll when navigating the docs.
- Add links validation to `npm run docs:link`.
- Reorganize the sidebar API Reference section.
This commit is contained in:
Simon Brunel
2020-01-09 20:41:09 +01:00
parent cc29ef3512
commit 7f9013a878
12 changed files with 260 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
docs/.vuepress/config.js
View File

@ -9,8 +9,9 @@ module.exports = {
themeConfig: {
repo: 'simonbrunel/qtpromise',
lastUpdated: 'Last Updated',
smoothScroll: true,
smoothScroll: false,
editLinks: true,
sidebarDepth: 2,
docsDir: 'docs',
algolia: {
apiKey: '0e6e9cccb8c2c360a5543e28c4e31cb8',
@ -26,50 +27,56 @@ module.exports = {
'/qtpromise/qtconcurrent',
'/qtpromise/qtsignals',
'/qtpromise/thread-safety',
'/qtpromise/api-reference',
{
title: 'QPromise',
title: 'API Reference',
path: '/qtpromise/api-reference',
children: [
'/qtpromise/qpromise/constructor',
'/qtpromise/qpromise/delay',
'/qtpromise/qpromise/each',
'/qtpromise/qpromise/fail',
'/qtpromise/qpromise/filter',
'/qtpromise/qpromise/finally',
'/qtpromise/qpromise/isfulfilled',
'/qtpromise/qpromise/ispending',
'/qtpromise/qpromise/isrejected',
'/qtpromise/qpromise/map',
'/qtpromise/qpromise/reduce',
'/qtpromise/qpromise/tap',
'/qtpromise/qpromise/tapfail',
'/qtpromise/qpromise/then',
'/qtpromise/qpromise/timeout',
'/qtpromise/qpromise/wait',
'/qtpromise/qpromise/reject.md',
'/qtpromise/qpromise/resolve.md'
]
},
{
title: 'Helpers',
children: [
'/qtpromise/helpers/all',
'/qtpromise/helpers/attempt',
'/qtpromise/helpers/connect',
'/qtpromise/helpers/each',
'/qtpromise/helpers/filter',
'/qtpromise/helpers/map',
'/qtpromise/helpers/reduce',
'/qtpromise/helpers/resolve'
]
},
{
title: 'Exceptions',
children: [
'/qtpromise/exceptions/canceled',
'/qtpromise/exceptions/context',
'/qtpromise/exceptions/timeout',
'/qtpromise/exceptions/undefined'
//['/qtpromise/api-reference', 'Overview'],
{
title: 'QPromise',
children: [
'/qtpromise/qpromise/constructor',
'/qtpromise/qpromise/delay',
'/qtpromise/qpromise/each',
'/qtpromise/qpromise/fail',
'/qtpromise/qpromise/filter',
'/qtpromise/qpromise/finally',
'/qtpromise/qpromise/isfulfilled',
'/qtpromise/qpromise/ispending',
'/qtpromise/qpromise/isrejected',
'/qtpromise/qpromise/map',
'/qtpromise/qpromise/reduce',
'/qtpromise/qpromise/tap',
'/qtpromise/qpromise/tapfail',
'/qtpromise/qpromise/then',
'/qtpromise/qpromise/timeout',
'/qtpromise/qpromise/wait',
'/qtpromise/qpromise/reject',
'/qtpromise/qpromise/resolve'
]
},
{
title: 'Helpers',
children: [
'/qtpromise/helpers/all',
'/qtpromise/helpers/attempt',
'/qtpromise/helpers/connect',
'/qtpromise/helpers/each',
'/qtpromise/helpers/filter',
'/qtpromise/helpers/map',
'/qtpromise/helpers/reduce',
'/qtpromise/helpers/resolve'
]
},
{
title: 'Exceptions',
children: [
'/qtpromise/exceptions/canceled',
'/qtpromise/exceptions/context',
'/qtpromise/exceptions/timeout',
'/qtpromise/exceptions/undefined'
]
}
]
}
]

2
docs/.vuepress/styles/index.styl
View File

@ -19,7 +19,7 @@ sup
#main-title
display none !important
.content a code
.page a code
color $accentColor
.navbar