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

creating a doc page with autodocs and everything #3273

Merged
merged 57 commits into from
Sep 18, 2023
Merged

creating a doc page with autodocs and everything #3273

merged 57 commits into from
Sep 18, 2023

Conversation

helpmefindaname
Copy link
Collaborator

@helpmefindaname helpmefindaname commented Jun 19, 2023

Building a doc page to contain more than just the tutorials.

  • ci-cd setup for multiple versions
  • extended contributor guide
  • versioning working with "latest" (main) and "stable" (latest released version)
  • autodocs for selected packages/modules
  • ensure that the module structure makes sense (e.g. flair.datasets vs flair.datasets.sequence_labeling, ...)
  • added all tutorials from the other doc page
  • fix weird behaivour of table of contents
  • link all classes in the tutorials
  • gather feedback about the basic design/setup to ensure this page as a long future.
  • landing page designed to our wishes @alanakbik will do this in a separate MR later.
  • add the flair icon
  • improve toc structure - which pages should show which depth
  • restructure version to be part of the header instead of the sidebar & hide ToC on main page.

The docs can be checkout locally and tested anytime by following the updating_documentation.md contributers guide. You know you have successfully built the docs, if you can watch the guide again in html format ;-)

Copy link
Collaborator

@alanakbik alanakbik left a comment

Choose a reason for hiding this comment

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

Everything looks good - thanks a lot for making all these changes and improving the documentation across the board!

I am not able to run sphinx-multiversion docs doc_build locally - it is giving me a "No package metadata was found for flair" unless I also install flair in the virtual environment. But then I get a "outputdir 'doc-page' for refs/remotes/origin/doc-page conflicts with other versions" error. Maybe you can walk me through it?

I also not the deploy action is not working. Aside from these things, I would say it is ready to merge and see in action!


## Setup

Flair requires python-3.7 or higher. To make sure our code also runs on the oldest supported
Copy link
Collaborator

Choose a reason for hiding this comment

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

3.8 very soon, we need to remember that this info needs to be changed here as well.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

is fixed

flair/__init__.py Show resolved Hide resolved
@@ -30,11 +30,12 @@


def set_proxies(proxies: typing.Dict[str, str]) -> None:
"""Allows for data downloaded from urls to be forwarded to a proxy.
r"""Allows for data downloaded from urls to be forwarded to a proxy.
Copy link
Collaborator

Choose a reason for hiding this comment

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

What does the "r" do?

Copy link
Collaborator Author

@helpmefindaname helpmefindaname Sep 11, 2023

Choose a reason for hiding this comment

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

the r prefix makes a string to a raw string meaning, that it doesn't use escape sequences etc.

for example r"\n" == "\\n" evaluates to a backslash followed by an n, while "\n" would evaluate to the enter symbol

flair/models/multitask_model.py Show resolved Hide resolved
flair/nn/distance/cosine.py Show resolved Hide resolved
@alanakbik
Copy link
Collaborator

Thanks a lot @helpmefindaname! This is really helpful and a big step towards improving our documentation!

@alanakbik alanakbik merged commit d5c1558 into master Sep 18, 2023
1 check passed
@alanakbik alanakbik deleted the doc-page branch September 18, 2023 12:39
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.

2 participants