Missing 1.0 API pages due to class alias

[Eric-Arellano]

The files qiskit.primitives.BaseEstimator and qiskit.primitives.BaseSampler are not being created in Qiskit 1.0 docs even though the HTML files exist in the Sphinx output uploaded to Box.

--

What's happening is that the HTML is really short and being classified as an attribute:

This is the HTML:

<section id="basesampler">
   <h1>BaseSampler<a class="headerlink" href="#basesampler" title="Permalink to this heading">¶</a></h1>
   <dl class="py attribute">
      <dt class="sig sig-object py" id="qiskit.primitives.BaseSampler">
         <span class="sig-prename descclassname"><span class="pre">qiskit.primitives.</span></span><span class="sig-name descname"><span class="pre">BaseSampler</span></span><a class="headerlink" href="#qiskit.primitives.BaseSampler" title="Permalink to this definition">¶</a>
      </dt>
      <dd>
         <p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseSamplerV1</span></code></p>
      </dd>
   </dl>
</section>

This code then returns this result, viewing it as an attribute API type:

documentation/scripts/commands/updateApiDocs.ts

Lines 166 to 168 in 5167d51

	for (const file of files) {
	const html = await readFile(join(htmlPath, file), "utf-8");
	const result = await sphinxHtmlToMarkdown({

{
  markdown: '<span id="baseestimator" />\n\n# BaseEstimator\n\nalias of `BaseEstimatorV1`\n',
  meta: { apiType: 'attribute', apiName: 'qiskit.primitives.BaseEstimator' },
  images: [],
  isReleaseNotes: false
}

That then gets removed due to this line that tries to inline the attribute into the non-existent class file for qiskit.primitives.BaseEstimator:

documentation/scripts/commands/updateApiDocs.ts

Line 207 in 5167d51

results = await mergeClassMembers(results);

If you comment out that line, we generate this file:

---
title: BaseSampler
description: API reference for qiskit.primitives.BaseSampler
in_page_toc_min_heading_level: 1
python_api_type: attribute
python_api_name: qiskit.primitives.BaseSampler
---

# BaseSampler

alias of `BaseSamplerV1`

---

I think there are two things we should do:

1. Update Qiskit 1.0 to include BaseSamplerV1 and BaseEstimatorV1 in their API docs. That way, we'll have their full class page, and then the pages for BaseSampler will link to the BaseSamplerV1 properly.
2. Fix our API generation script to handle this situation. We can't get rid of mergeClassMembers because it's necessary for historical API docs. Instead, we should change its logic to recognize this edge case. Maybe look if the attribute starts with the string "alias of" & check that there is no corresponding class page?

[Eric-Arellano]

Closed by #814. Qiskit has a PR up to add the missing BaseEstimatorV1 page.