Can't auto-generate a sidebar

[samarmeena]

Before recent update

After recent update

Config

plugins: [
    [
      "docusaurus-plugin-typedoc",
      // Plugin / TypeDoc options
      {
        entryPoints: ["../src/index.ts"],
        tsconfig: "../tsconfig.json",
        excludePrivate: true,
        excludeExternals: true,
        excludeProtected: true,
        readme: "none",
      },
    ],
  ],

Not sure about the actual issue, please provide a solution.

Thank you

[tgreyuk]

In your sidebars.js please replace:

API: require('./typedoc-sidebar.js'),

with:

'API': [
      {
        type: 'autogenerated',
        dirName: 'api', // 'api' is the 'out' directory
      },
    ],

I will update the README.

[samarmeena]

In your sidebars.js please replace:

API: require('./typedoc-sidebar.js'),

with:

'API': [
      {
        type: 'autogenerated',
        dirName: 'api', // 'api' is the 'out' directory
      },
    ],

I will update the README.

Sidebar.js

...
    {
      type: "category",
      label: "API",
      items: [
        {
          type: "autogenerated",
          dirName: "api", // 'api' is the 'out' directory
        },
      ],
    },
...

Issue not resolved

It's important to delete old API folder before running npm run build to reproduce this issue.

Question

is there way to disable typedoc-sidebar.js file generation?, because that is not required.

[samarmeena]

Steps to reproduce issue

1. Execute git clone https://github.com/oceanroleplay/discord.ts.git
2. cd docs
3. update all dependencies to latest (ncu -u, later npm install)
4. make necessary changes as per new update in docusaurus-plugin-typedoc
5. Execute npm run build
6. Execute npm run serve
7. Navigate to http://localhost:3001/discord.ts/docs/installation

Issue

Sidebar API category is missing (Below is example output of sidebar if correctly build)

[tgreyuk]

Thanks i found out what the problem was. fix in 0.16.2. Have tested on your repo and appears to build fine now. Have also removed sidebar generation but actually that was as a bit of a red herring.

[tgreyuk]

Please close if you are happy or let me know if still an issue..

[samarmeena]

I am testing now, will update in few mins.

[samarmeena]

@tgreyuk it appear that, api docs are generated correctly, but sidebar is still not generated.

With sidebar config

...
    {
      type: "category",
      label: "API",
      items: [
        {
          type: "autogenerated",
          dirName: "api", // 'api' is the 'out' directory
        },
      ],
    },
...

[tgreyuk]

ok thanks - strange - if docs are generated then assume it is some kind of docusaurus config issue. will have a proper look later.

[samarmeena]

@tgreyuk any ETA for fix? This is holding up the upgrade of dependencies in our project.

[tgreyuk]

@OceanRoleplay have made a few amends in 0.16.3. Have followed the steps above and all looks good to me - sidebar is displayed as expected:

[samarmeena]

@OceanRoleplay have made a few amends in 0.16.3. Have followed the steps above and all looks good to me - sidebar is displayed as expected:

Wow, that's wonderful. Maybe I had got something wrong. Now it's working alright.

Thank you for your help and support, closing issue now.