Skip to content

Commit

Permalink
Merge branch 'master' into patch-2
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Mc authored Dec 29, 2022
2 parents cf31f77 + a276b7e commit d4166be
Show file tree
Hide file tree
Showing 233 changed files with 15,164 additions and 2,870 deletions.
7 changes: 2 additions & 5 deletions .ci/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
FROM python:slim
FROM conanio/ci-docs

COPY requirements.txt /tmp/

RUN apt-get update \
&& apt-get install -y enchant git make latexmk texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra \
&& pip3 install --requirement /tmp/requirements.txt

RUN pip3 install --requirement /tmp/requirements.txt
47 changes: 43 additions & 4 deletions .ci/publish.jenkins
Original file line number Diff line number Diff line change
@@ -1,8 +1,33 @@
#!groovy​


// TODO: Move to a file and avoid modifying CI script
Map<String, String> versions = [
'release/1.32.0': '1.32',
'release/1.56.0': '1.56',
'release/1.55.0': '1.55',
'release/1.54.0': '1.54',
'release/1.53.0': '1.53',
'release/1.52.0': '1.52',
'release/1.51.3': '1.51',
'release/1.50.2': '1.50',
'release/1.49.0': '1.49',
'release/1.48.2': '1.48',
'release/1.47.0': '1.47',
'release/1.46.2': '1.46',
'release/1.45.0': '1.45',
'release/1.44.1': '1.44',
'release/1.43.4': '1.43',
'release/1.42.2': '1.42',
'release/1.41.0': '1.41',
'release/1.40.4': '1.40',
'release/1.39.0': '1.39',
'release/1.38.0': '1.38',
'release/1.37.2': '1.37',
'release/1.36.0': '1.36',
'release/1.35.2': '1.35',
'release/1.34.1': '1.34',
'release/1.33.1': '1.33',
'release/1.32.1': '1.32',
'release/1.31.4': '1.31',
'release/1.30.2': '1.30',
'release/1.29.2': '1.29',
Expand Down Expand Up @@ -31,7 +56,8 @@ Map<String, String> versions = [
'release/1.6.1': '1.6',
'release/1.5.2': '1.5',
'release/1.4.5': '1.4',
'release/1.3.3': '1.3'
'release/1.3.3': '1.3',
'release/2.0.0-beta': '2.0'
]

node('Linux') {
Expand Down Expand Up @@ -87,12 +113,22 @@ node('Linux') {
image.inside {
stage('Prepare sources') {
writeJSON json: versions, file: "${folderName}/versions.json"
if (folderName != 'latest') {
if (folderName != 'latest') {
sh "rm -fr ${folderName}/_themes/conan"
sh "cp -a latest/_themes/. ${folderName}/_themes/"
}
if (folderName == '2.0') {
def conanBranch = 'release/2.0-beta'
def conan_repo_url = 'https://github.com/conan-io/conan.git'
stage('Clone sources') {
def cloneConan = "git clone --single-branch -b ${conanBranch} --depth 1 ${conan_repo_url} 2.0/conan_sources"
sh(script: cloneConan)
}
// for some reason even adding this to autodoc_mock_imports
// does not work, se we have to install the real dependency
sh(script: 'pip3 install colorama')
}
}

stage('HTML') {
sh "sphinx-build -W -b html -d ${folderName}/_build/.doctrees ${folderName}/ gh-pages/en/${folderName}"
}
Expand All @@ -102,6 +138,9 @@ node('Linux') {
sh "make -C ${folderName}/_build/latex all-pdf"
sh "cp ${folderName}/_build/latex/conan.pdf gh-pages/en/${folderName}/conan.pdf"
}
if (folderName=='2.0') {
sh 'rm -fr 2.0/conan_sources'
}
}
}
}
Expand Down
12 changes: 8 additions & 4 deletions .ci/test.jenkins
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,14 @@ node('Linux') {
},
linkcheck: {
image.inside {
int output = sh(script: 'make linkcheck', returnStatus: true)
if (output != 0 && isMaster) {
currentBuild.result = 'FAILURE'
error('Stop here, linkcheck failed!')
def status = sh(returnStatus: true, script: 'make linkcheck > links_output.txt')
sh 'cat links_output.txt'
if (status != 0) {
def broken_links = sh(returnStdout: true , script: 'cat links_output.txt | grep broken')
echo "Broken Links: \n ${broken_links}"
def subject = "Broken links in `conan-io/docs`: ${env.BUILD_URL}"
def summary = "${subject}\n```\n${broken_links}\n```"
slackSend (color: '#FF0000', message: summary)
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ __pycache__/

# Distribution / packaging
.Python
env/
_build/
develop-eggs/
dist/
Expand All @@ -24,6 +23,7 @@ var/
*.egg-info/
.installed.cfg
*.egg
venv

# PyInstaller
# Usually these files are written by a python script from a template
Expand Down
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To make any contribution to Conan documentation fork this repository and open a
Style Guidelines
----------------

This guidelines are just general good practices for the formatting and structure of the whole documentation and do not pretend to be a
These guidelines are just general good practices for the formatting and structure of the whole documentation and do not pretend to be a
stopper for any helpful contribution. Any contribution that may include relevant information for Conan users will always be welcomed.

Conan documentation is written in [reStructuredText](http://docutils.sourceforge.net/rst.html) and
Expand Down Expand Up @@ -166,7 +166,7 @@ Use them in the following importance order:
```
.. warning::
In the Bintray repositories there are binaries for several mainstream compilers...
In the ConanCenter repository there are binaries for several mainstream compilers...
```

```
Expand Down Expand Up @@ -206,16 +206,12 @@ Or reference the :ref:`conan_export_pkg_command` directly.
Use external references with external URL at the bottom of the file like this:

```
Submit a request to include it in `conan-center`_.
Submit a pull request to include it in `conan-center-index`_.
...
...
.. _`conan-center`: https://bintray.com/conan/conan-center
.. _`conan-center`: https://center.conan.io
```

In case you want to use explicit external references with a link, make sure it doesn't exceed the maximum line length, otherwise it
should considered to be written as a normal external reference.

```
If you are just evaluating conan, you can create an account on https://bintray.com
```
10 changes: 4 additions & 6 deletions _themes/conan/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,13 +158,11 @@
{% include "breadcrumbs.html" %}
<!--<select id="search" name="state" multiple="true" onchange="window.location = reldir + this.value;" style="width:90%"></select>
<hr/>-->
<!--<div class="admonition important"> Join the <a href=https://blog.conan.io/2020/07/28/Launching-Conan-2.0-Tribe.html>Conan 2.0 Tribe</a> and contribute to define the next Conan 2.0 major version</div>-->
<div class="admonition important">
<!--<div class="admonition important">
<p class="admonition-title">Announcement</p>
<p>Check out the new free <a
href=https://blog.conan.io/2020/09/24/New-conan-training-series.html>Conan
training courses on JFrog Academy</a>!
</div>
<p>Recipe Hacking no. 2! Building on what we learnt during the first installment we will be working on more Conan 2.0 Migration! We'll start by reviewing some open pull requests and hopefully tackle a CMake example. <a
href=https://jfrog.zoom.us/webinar/register/WN_grFhqH0yRBeIfJmBvQoPJw> Register here to attend.</a></p>
</div>-->
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
{% block body %}{% endblock %}
Expand Down
Loading

0 comments on commit d4166be

Please sign in to comment.