Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Articles without any content at all should be removed #50

Closed
username223 opened this issue Jan 1, 2021 · 3 comments · Fixed by #52
Closed

Articles without any content at all should be removed #50

username223 opened this issue Jan 1, 2021 · 3 comments · Fixed by #52

Comments

@username223
Copy link
Contributor

Several articles are completely empty except for a main header.

This leads to significant bloat in the documentation with titles that do not contain any useful information anyway.

One example is Developer_Environment/openocd/openocd.rst.

These files can be commented out in the index.rst file to remove them from the index, but this will produce the WARNING: document isn't included in any toctree error for each file. Ideally all the files should just be deleted and removed from the index, and any titles requiring body text should be added to an issue.

The full list of empty files is:

Developer_Environment/openocd/openocd.rst
Components/arch.rst
Components/Hal_drv/gpio.rst
Components/Middleware/bloop/bloop.rst
Components/Middleware/blsync/blsync.rst
Components/Middleware/security/security.rst
Components/Network/httpc/httpc.rst
Components/Network/https/https.rst
Components/Network/tls/tls.rst
Components/BLE/provision_WiFi/provision_WiFi.rst
Components/BLE/mesh/mesh.rst

Notice that GPIO has an entry in both Components and Examples. I'm unsure of the difference in content.

@tchebb
Copy link
Contributor

tchebb commented Jan 1, 2021

Deleting all these makes sense to me.

@Avamander
Copy link
Contributor

Avamander commented Jan 1, 2021

Some of these seem to me like they are a workaround to some bug with html generation. I'd check before removing if the resulting HTML is the same.

@username223
Copy link
Contributor Author

Some of these seem to me like they are a workaround to some bug with html generation. I'd check before removing if the resulting HTML is the same.

I'll take a look.

Some files (not listed above) do indeed attempt to include a file that does not exist, as described in issue #46 and fixed in PR #48, but I don't think any of the listed files attempt to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants