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

Remove index.md files from being searched #1805

Merged
merged 1 commit into from
Mar 8, 2022

Conversation

kaixin-hc
Copy link
Contributor

What is the purpose of this pull request?
Fixes #1803

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • Others, please explain:

Overview of changes:
Adds the index files in devGuide and userGuide to the list of files which should not be indexed for search.

Anything you'd like to highlight / discuss:

Testing instructions:
Not sure how to test the ug-site and dg-site.json as opposed to site.json. I'm wondering if this is an area in the documentation we should improve.

Proposed commit message: (wrap lines at 72 characters)
Docs: Remove index.md files from being searched


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

Copy link
Contributor

@jonahtanjz jonahtanjz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @kaixin-hc! This seems to remove index.md from the search for both ug and dg.

Agree with #1803 (comment) that we should find a way to format the titles of the files as well if needed. Can be a separate PR to work on this :)

Not sure how to test the ug-site and dg-site.json as opposed to site.json. I'm wondering if this is an area in the documentation we should improve.

To test the ug-site and dg-site individually, you can try:

  1. cd docs
  2. markbind serve -s ug-site.json or markbind serve -s dg-site.json

Using the -s option allows you to choose which config file to use for serving/building the site. This is documented under the serve command but I guess we can include a section within the dev guide to show how each of the individual site can be served :)

LGTM 👍

@jonahtanjz jonahtanjz added this to the 4.0 milestone Mar 7, 2022
@jonahtanjz jonahtanjz merged commit 3238f43 into MarkBind:master Mar 8, 2022
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 this pull request may close these issues.

UG/DG index.md filepath appears in search results
2 participants