docs: reference filters implementation details

boostorg · May 24, 2024 · 24de10f · 24de10f
1 parent 50f7247
commit 24de10f
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 6 deletions.
diff --git a/doc/generate-files.mjs b/doc/generate-files.mjs
@@ -185,11 +185,11 @@ if (isBoostDir(cwdParentParent)) {
 
     Install MrDocs with:
         - Linux:
-            wget https://github.com/cppalliance/mrdocs/releases/download/develop-release/MrDocs-1.0.0-Linux.tar.gz
-            sudo tar -xzf MrDocs-1.0.0-Linux.tar.gz -C /usr/local --strip-components=1
+            wget https://github.com/cppalliance/mrdocs/releases/download/develop-release/MrDocs-0.0.1-Linux.tar.gz
+            sudo tar -xzf MrDocs-0.0.1-Linux.tar.gz -C /usr/local --strip-components=1
         - Windows (Powershell):
-            Invoke-WebRequest -Uri 'https://github.com/cppalliance/mrdocs/releases/download/develop-release/MrDocs-1.0.0-win64.7z' -OutFile 'MrDocs-1.0.0-win64.7z'
-            7z x -o"C:\Users\$env:USERNAME\Applications" 'MrDocs-1.0.0-win64.7z'
+            Invoke-WebRequest -Uri 'https://github.com/cppalliance/mrdocs/releases/download/develop-release/MrDocs-0.0.1-win64.7z' -OutFile 'MrDocs-0.0.1-win64.7z'
+            7z x -o"C:\Users\$env:USERNAME\Applications" 'MrDocs-0.0.1-win64.7z'
             ( Adapt the destination path as needed )
 
  */
@@ -246,13 +246,17 @@ let mrDocsExitCode = 0
 try {
     const mrDocsOutput = execSync(mrDocsCmd)
     console.log(mrDocsOutput.toString())
+    console.log(`Generated documentation at ${mrDocsOutputDir}`)
 } catch (error) {
+    console.error('Failed to run MrDocs')
     console.error(error.stdout.toString())
     mrDocsExitCode = error.status
 }
 if (tempDir) {
     console.log(`Deleting temporary directory ${tempDir}`)
     execSync(`rm -rf ${tempDir}`)
 }
-console.log(`Generated documentation at ${mrDocsOutputDir}`)
+if (mrDocsExitCode !== 0) {
+    console.log(`Exiting with code ${mrDocsExitCode}`)
+}
 process.exit(mrDocsExitCode)
diff --git a/doc/mrdocs.yml b/doc/mrdocs.yml
@@ -12,9 +12,26 @@ source-root: ..
 filters:
   symbols:
     exclude:
+      # We don't want namespace pages for other libraries
+      - 'std'
+      - 'std::*'
+      - 'boost::system'
+      - 'boost::empty_'
+      - 'boost::system::*'
+      # Exclude implementation details
       - 'boost::urls::detail'
       - 'boost::urls::*::detail'
-      - 'boost::empty_'
+      # Exclude implementation details defined elsewhere
+      - 'boost::urls::*_unsafe'
+      - 'boost::urls::*_t'
+      - 'boost::urls::make_error_code'
+      - 'boost::urls::make_void'
+      - 'boost::urls::grammar::*_t'
+      - 'boost::urls::grammar::make_error_*'
+      - 'boost::urls::grammar::operator_*'
+      - 'boost::urls::string_token::*_t'
+    include:
+      - 'boost::urls::no_value_t'
 inaccessible-members: never
 inaccessible-bases: never