Merge pull request #27 from saraedum/readme-docs

Link to documentation in README
flatsurf · Nov 13, 2023 · eb4c0dc · eb4c0dc
2 parents 85c52c3 + 1fc2482
commit eb4c0dc
Show file tree

Hide file tree

Showing 11 changed files with 11 additions and 10 deletions.
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -9,7 +9,7 @@ concurrency:
 
 jobs:
   asv:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
         with:

diff --git a/.github/workflows/conda.yml b/.github/workflows/conda.yml
@@ -9,7 +9,7 @@ concurrency:
 
 jobs:
   conda-build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v2
       with:

diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -9,7 +9,7 @@ concurrency:
 
 jobs:
   codecov:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
         with: { submodules: recursive, fetch-depth: 0 }

diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -9,7 +9,7 @@ concurrency:
 
 jobs:
   build-manual:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
         with: { submodules: recursive }

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -9,7 +9,7 @@ concurrency:
 
 jobs:
   clang-format:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
       - uses: DoozyX/[email protected]

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -9,7 +9,7 @@ concurrency:
 
 jobs:
   test-gmpxxll:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         target:

diff --git a/README.md b/README.md
@@ -7,6 +7,8 @@ A header only library that adds long long functions to GMP's C++ interface.
 
 What you're looking for is in [`gmpxxll/`](./gmpxxll).
 
+Consult the [documentation](https://flatsurf.github.io/gmpxxll) for usage details.
+
 This repository exists so we could share the code between the various projects in the flatsurf project that almost all needed this functionality at some point.
 
 This set of functions is certainly not complete and could likely be improved. Pull Requests are always welcome.

diff --git a/asv.conf.json b/asv.conf.json
@@ -10,13 +10,13 @@
     "automake": [],
     "benchmark==1.5.0": [],
     "ccache": [],
-    "cppasv": [],
+    "flatsurf::cppasv": [],
     "cxx-compiler": [],
     "gmp": [],
     "libtool": [],
     "make": []
   },
-  "conda_channels": ["flatsurf", "conda-forge", "default"],
+  "conda_channels": ["conda-forge"],
   "build_command": [
     "autoreconf -ivf",
     "/bin/sh configure CXX='ccache c++' --without-doc",

diff --git a/doc/environment.yml b/doc/environment.yml
@@ -6,7 +6,6 @@
 name: doc-eantic-build
 channels:
   - conda-forge
-  - defaults
 dependencies:
   - saraedum::standardese>=0.6.0
   - mkdocs>=1.1.0

diff --git a/environment.yml b/environment.yml
@@ -4,7 +4,6 @@
 name: gmpxxll-build
 channels:
   - conda-forge
-  - defaults
 dependencies:
   - automake
   - benchmark

diff --git a/recipe/meta.yaml b/recipe/meta.yaml
@@ -15,6 +15,7 @@ requirements:
   build:
     - libtool
     - automake
+    - make
     - coreutils
     - {{ compiler('cxx') }}
   host:
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,7 +9,7 @@ concurrency: @@
     jobs:
       asv:
-        runs-on: ubuntu-20.04
+        runs-on: ubuntu-22.04
         steps:
           - uses: actions/checkout@v2
             with:
@@ Expand Down @@